Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix multiple typographical issues #61

Open
wants to merge 9 commits into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 11 additions & 11 deletions docs/INSTRUCTIONS.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
- [Instructions for Who Can Be a Member](#instructions-for-who-can-be-a-member)
- [Instructions for Once You Are a Member](#instructions-for-once-you-are-a-member)
- [Use of Large File Storage and GitHub Actions](#use-of-large-file-storage-and-github-actions)
- [GitHubPages and Websites](#githubpages-and-websites)
- [GitHub Pages and Websites](#githubpages-and-websites)
- [Enabling Discussions and Other Beta Features](#enabling-discussions-and-other-beta-features)
- [Most Common Requests](#most-common-requests)
- [Related Sites](#related-sites)
Expand All @@ -32,21 +32,21 @@ For information on how to become a member of the NASA Org (you need to be a NASA
To ensure mandatory policies are followed, NASA org members are not given the full admin rights you might be used to on your personal github.com accounts. However, by using teams, team owners, collaborators, and outside collaborators roles we can make the experience pretty quick and easy.

#### Org Owners
We currently have two active owner in the org:
We currently have two active owners in the org:

Miles Crabbe : github username = MilesCrabbe

Elizabeth Wainwright : github username = elizabeth-wainwright

A general purpose contact email is <a href="mailto:[email protected]">[email protected]</a>, please mention the specific nature of your question as this email is also used on data.nasa.gov & api.nasa.gov.

<b>Only org owners have the ability to create new repositories, bring new users in as members of the NASA github org, and make changes to settings of repositories</b>. If there is something a member of the nasa org can not do that this arragement prevents, please reach out.
<b>Only org owners have the ability to create new repositories, bring new users in as members of the NASA github org, and make changes to settings of repositories</b>. If there is something a member of the nasa org can not do that this arrangement prevents, please reach out.

#### Repos
We do not give out admin rights on any NASA Github repos for reasons stated above. If you want a new repo created or want to edit settings on an existing repo that require admin access, please contact one of our org owners. Without admin rights on a repository, you'll still be able to make any code changes yourself as long as you're a collaborator on that repository or a member of a team whose participants are collaborators by default.

##### Required Information When Requesting New Repository
If you need for a new repository (and it has gotten SRA approval) please either submit a modification to your NAMs request with the follwing information:
If you need for a new repository (and it has gotten SRA approval) please either submit a modification to your NAMs request with the following information:

- **Name of the repository**
- About Tab Information: These will appear on the repo's home page in the "about" section. They are extractable as metadata and assist in discoverability.
Expand All @@ -71,7 +71,7 @@ Note: Team maintainers are technically able to add a user who was once in the NA
#### Collaborators
Github also has a role called "collaborator". This is someone who doesn't have repository ownership or admin rights but can push edits to code directly without doing a pull request.

If you would like to add a NASA staff member who is a member of the NASA org as a collaborator on a single repository, we still suggest you contact the NASA org owners mentioned above about setting up a TEAM for that single repository instead of adding people one by one. Teams result in less requestes (and therefore waiting) on NASA org owners for actions. We are sorry you don't have normal full ownership rights. It is because everyone with write access needs to be approved NASA user. If you had normal repository owner right, you could add any github user.
If you would like to add a NASA staff member who is a member of the NASA org as a collaborator on a single repository, we still suggest you contact the NASA org owners mentioned above about setting up a TEAM for that single repository instead of adding people one by one. Teams result in less requests (and therefore waiting) on NASA org owners for actions. We are sorry you don't have normal full ownership rights. It is because everyone with write access needs to be approved NASA user. If you had normal repository owner right, you could add any github user.

#### Outside Collaborators
Only on a rare case-by-case basis we will allow non-NASA users to be added to the org as Outside Collaborators. You can collaborate without this status via forks, branches, and pull-requests. If you fork a repository, you can make changes and then submit back a pull-request. A repository maintainer can then approve those changes. You do not need formal outside-collaborator status for this!
Expand All @@ -84,9 +84,9 @@ Please reach out to us if you have any questions.
#### Billing Plan & Impact on Features
A very small number of GitHub features depend on what billing plan your organization uses. This varies over time, so please refer to GitHub documentation for this information.

Github.com/nasa is on a "legacy" billing plan until October 1st, 2022 at which time it switches to a “free” plan. Free plan has costs for GitHubActions and Package storage, so there may be a future point in time when those features would be curtailed for the heaviest users. Any change would be announced. GitHub.com/nasa is not on an Enterprise plan as it would trigger internal policies that would require payment at the individual level resulting in less open source code released.
Github.com/nasa is on a "legacy" billing plan until October 1st, 2022 at which time it switches to a “free” plan. Free plan has costs for GitHub Actions and Package storage, so there may be a future point in time when those features would be curtailed for the heaviest users. Any change would be announced. GitHub.com/nasa is not on an Enterprise plan as it would trigger internal policies that would require payment at the individual level resulting in less open source code released.

### GitHubPages and Websites
### GitHub Pages and Websites
You must contact an administrator to help you turn on GitHub pages. Please let them know the branch being used and whether the starting `index.html` file is under the top level of the repository or the `docs` folder.

<i>PLEASE NOTE: GitHub pages can be used for documentation of NASA open source code. You can not use GitHub pages to stand up a NASA website as it will not be under the nasa.gov domain.</i> Please contact the github.com/nasa administrators listed elsewhere on this page if you have any questions about the interpretation of this policy.
Expand All @@ -110,7 +110,7 @@ Need: <i>If you need to be added to the NASA org on github.com/</i>

Need: <i>If you need to add a new open-sourced repository to github.com/nasa that has already been approved via the software release authority process.</i>

- Make or modify a request to start a new repository in github.com/nasa via the <a href="https://idmax.nasa.gov/nams/asset/227756">NAMs request</a>. Please give it a useful name and good documentation! We'll create a blank repository for you to put the code into. Please note that you will not be able to get to that link if you are not inside the NASA firewall. In your NAMs request, please include all the required metadata describing the respository listed in the "REPO" section above. If this is the first repository you're open sourcing, you might also want to read through the longer description of how to supply the metadata <a href="https://github.com/nasa/instructions/blob/master/docs/about_section_instructions.md">here</a>.
- Make or modify a request to start a new repository in github.com/nasa via the <a href="https://idmax.nasa.gov/nams/asset/227756">NAMs request</a>. Please give it a useful name and good documentation! We'll create a blank repository for you to put the code into. Please note that you will not be able to get to that link if you are not inside the NASA firewall. In your NAMs request, please include all the required metadata describing the repository listed in the "REPO" section above. If this is the first repository you're open sourcing, you might also want to read through the longer description of how to supply the metadata <a href="https://github.com/nasa/instructions/blob/master/docs/about_section_instructions.md">here</a>.
<hr>
Need: <i>If you need to create a new team for managing who has access to make changes on a particular repository or group of repositories.</i>

Expand Down Expand Up @@ -150,7 +150,7 @@ The reason for NASA open source code existing in different places boils down to
Other NASA orgs on github.com or gitlab.com or bitbucket
Although NASA staff are highly encouraged to release open source software on github.com/nasa as that is where most people look so it ensures higher potential reuse, they are not absolutely required to use that org account. A common reason code may exist under other orgs is that the software is jointly maintained by non-NASA persons or the code was developed by non-NASA persons through a NASA grant.

To encourage disoverability, please use the #NASA topic tag on any GitHub or GitLab repositories not under github.com/nasa. Doing so helps create views of NASA open source code beyond what is under github.com/nasa.
To encourage discoverability, please use the #NASA topic tag on any GitHub or GitLab repositories not under github.com/nasa. Doing so helps create views of NASA open source code beyond what is under github.com/nasa.

For example, <a href="https://justingosses.github.io/nasa-repos-visual-explorer/explore/">this webpage creates visualizations of trends and connections between NASA repositories</a> across many org accounts and not just github.com/nasa.

Expand All @@ -166,7 +166,7 @@ Please make sure any repos added to github.com/nasa are also tracked in code.nas

Code.nasa.gov uses both human and A.I. generated tags to help users find NASA open source that is useful for their goals.

![image of sreenshot of code.nasa.gov showing details for Open MCT project](https://raw.githubusercontent.com/nasa/instructions/master/assets/code_demo.png)
![image of screenshot of code.nasa.gov showing details for Open MCT project](https://raw.githubusercontent.com/nasa/instructions/master/assets/code_demo.png)


Screenshot of NASA's project OPEN MCT
Expand All @@ -179,7 +179,7 @@ The information on software.nasa.gov is presented in a way that leverages NASA's

It also includes some older software products that are only available as downloadable zip files as well as software that must be requested individually as they are only open to US persons or are tied to a patent.

![image of sreenshot of software.nasa.gov showing the categories of NASA software](https://raw.githubusercontent.com/nasa/instructions/master/assets/software.png)
![image of screenshot of software.nasa.gov showing the categories of NASA software](https://raw.githubusercontent.com/nasa/instructions/master/assets/software.png)
Screenshot of NASA's software categories


Expand Down