-
Notifications
You must be signed in to change notification settings - Fork 9
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Various fixes to typos - Various fixes to rendering / styling of pages
- Loading branch information
Showing
9 changed files
with
128 additions
and
19 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,95 @@ | ||
| --- | ||
| sidebar_position: 2 | ||
| --- | ||
|
|
||
| # ✅ Getting Started | ||
|
|
||
| We have numerous guides and recommendations on this website. You are free to explore and take what you find most helpful. However, if you're looking for more guidance on how to bring together SLIM's recommendations for your project in an aggregated form, you've come to the right place. | ||
|
|
||
| ## Checklist | ||
|
|
||
| Here we present a checklist you can run through for your project, as well as links to automation / guides to make your project ready with the best of SLIM. | ||
|
|
||
| Review your project's repositories, and ensure all have the following (in prioritized order): | ||
|
|
||
| | Checklist Item | Why? | Done? | | ||
| | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | ----- | | ||
| | LICENSE | Spell out legal terms for software usage & modification | ✅ or ❌ | | ||
| | [README](documentation/readme/) | Provide project overview, setup, & usage instructions | ✅ or ❌ | | ||
| | [Contributing Guide](governance/contributions/contributing-guide) | Outline how to contribute & the process for submissions | ✅ or ❌ | | ||
| | [Code of Conduct](governance/contributions/code-of-conduct) | Establish community behavior standards | ✅ or ❌ | | ||
| | [Issue Templates](governance/contributions/issue-templates/) | Streamline issue reporting for consistency & clarity | ✅ or ❌ | | ||
| | [Pull Request Templates](governance/contributions/pull-requests/) | Ensure PRs are comprehensive & adhere to project standards | ✅ or ❌ | | ||
| | [Documentation](documentation/documentation-hosts/) | Offer detailed info on features, APIs, & customizations not covered in README | ✅ or ❌ | | ||
| | [Change Log](documentation/change-log/) | Keep track of all notable changes in each version in a human-readable format | ✅ or ❌ | | ||
| | [Security & Dependency Scanning](software-lifecycle/security/github-security) | Identify vulnerabilities & outdated dependencies for security | ✅ or ❌ | | ||
| | [Sensitive Information Scanning](software-lifecycle/security/secrets-detection/) | Detect accidental commits of sensitive info | ✅ or ❌ | | ||
| | [Governance Model](governance/governance-model/) | Define decision-making structure & project leadership for transparency & organization | ✅ or ❌ | | ||
|
|
||
|
|
||
| ## Repository Starter Kit | ||
|
|
||
| If you're starting a new project / repository, you can automatically get many of the above setup quickly using our: | ||
|
|
||
| **🌐 [Repository Starter Kit](https://github.com/nasa-ammos/slim-starterkit)** | ||
|
|
||
| ### Using GitHub's "Use this template" Button | ||
|
|
||
| 1. **Navigate to the Starter Kit**: Go to the [SLIM Repository Starter Kit](https://github.com/nasa-ammos/slim-starterkit) on GitHub. | ||
| 2. **Create Your Repository**: Click the "Use this template" button at the top right of the GitHub repository page. | ||
|  | ||
| Example screenshot of button to click. | ||
| 3. **Set Up Your New Repository**: Fill in the Repository name and description for your new project. Decide whether your repository will be public or private. Click "Create repository from template". | ||
| 4. **Customize Your Repository**: After creation, go through your new repository and look for files containing the `[INSERT ...]` text. These are placeholders for you to replace with information specific to your project. This includes project name, description, contributing guidelines, etc. | ||
| 5. **Push Changes**: Once you've made your customizations, commit and push the changes to your repository to ensure all your project information is up to date. | ||
|
|
||
| ### Manually Cloning and Using the Repository | ||
|
|
||
| If you prefer to set up your project manually or need more control over the initial setup, follow these steps: | ||
|
|
||
| 1. **Clone the Starter Kit**: | ||
| - Open your terminal or command prompt. | ||
| - Navigate to the directory where you want your project to be. | ||
| - Clone the repository using: | ||
| ```bash | ||
| git clone https://github.com/nasa-ammos/slim-starterkit.git YOUR_PROJECT_NAME | ||
| ``` | ||
| - Replace `YOUR_PROJECT_NAME` with the desired name of your project folder. | ||
|
|
||
| 2. **Navigate to Your Project Directory**: | ||
| ```bash | ||
| cd YOUR_PROJECT_NAME | ||
| ``` | ||
|
|
||
| 3. **Remove the Git History** and start fresh: | ||
| ```bash | ||
| rm -rf .git | ||
| git init | ||
| ``` | ||
|
|
||
| 4. **Customize Your Project**: Go through the cloned files and modify any `[INSERT ...]` placeholders with information relevant to your project. This step is crucial for tailoring the starter kit to your specific project needs. | ||
|
|
||
| 5. **Initial Commit**: | ||
| - Add all the files to your new git repository: | ||
| ```bash | ||
| git add . | ||
| ``` | ||
| - Commit the changes: | ||
| ```bash | ||
| git commit -m "Initial commit with SLIM Repository Starter Kit" | ||
| ``` | ||
|
|
||
| 6. **Create a New Repository on GitHub** (or your preferred Git hosting service) without initializing it with a README, .gitignore, or license since your project already contains these files. | ||
|
|
||
| 7. **Link Your Local Repository to GitHub**: | ||
| - Follow the instructions provided by GitHub to push an existing repository from the command line, which will include: | ||
| ```bash | ||
| git remote add origin <repository-URL> | ||
| git branch -M main | ||
| git push -u origin main | ||
| ``` | ||
|
|
||
| 8. **Push Your Changes**: Ensure all your customizations and initial setup are pushed to your remote repository. | ||
|
|
||
| By following these steps, you'll have a new project set up with best practices in repository setup, including a LICENSE, README, contributing guide, and more. Remember to keep your project information up to date and regularly review the repository for any updates to the starter kit that might be beneficial to your project. | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,8 +1,8 @@ | ||
| { | ||
| "label": "Documentation", | ||
| "position": 3, | ||
| "label": "💬 Information Sharing", | ||
| "position": 5, | ||
| "link": { | ||
| "type": "generated-index", | ||
| "description": "Check out our below list of guides and sub-sections related to documentation best practices." | ||
| "description": "Check out our below list of guides and sub-sections related to information sharing best practices." | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.