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

New Page for Joining SLIM #152

Merged
merged 1 commit into from
Mar 27, 2024
Merged
Show file tree
Hide file tree
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
51 changes: 3 additions & 48 deletions docs/about/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ sidebar_position: 1

Software Lifecycle Improvement & Modernization (SLIM) is a project focused on collecting, developing, and disseminating best practices and process improvement strategies in NASA multi-mission software development lifecycle ecosystems. SLIM represents both a community of contributors as well as a continually evolving repository for best practices documentation.

SLIM best practice guides and recommendations are all open source, which means you have the freedom to use our work (in accordance with our permissive [LICENSE](https://nasa-ammos.github.io/slim/LICENSE)) as well as contribute and help shape our future work. We're excited to welcome new contributors and users.

## Our Focus

There are three key areas within the software development lifecycle improvement space that SLIM focuses on providing best practice guidance for:
Expand Down Expand Up @@ -75,51 +77,4 @@ The following list of public projects are currently SLIM community members:
<li>Point of Contact: <a href="https://github.com/hookhua">@hookhua</a></li>
</ul>
</li>
</ul>

## How To Get Involved

SLIM best practice guides and recommendations are open source, which means you have the freedom to use our work (in accordance with our [LICENSE](https://nasa-ammos.github.io/slim/LICENSE)) as well as contribute and help shape our future work. We're excited to welcome new contributors and users.

Some ways you can get involved with SLIM:

### Use Our Guides

The fastest way to start using SLIM process improvement solutions is to take a look at our best practice guides, specifically our *starter kits*. Starter kits provide plug-and-play solutions to process improvement needs. To complement our starter kits, take a look at *use cases* to understand the context of the starter kit solutions, *trade studies* to understand tool / solution trade-offs, and *reference architectures* to understand how tool / solutions interact in an actual working environment.

We recommend creating pull-requests using our starter kits against your own repositories. Reach out to our [contributor communication channels](docs/contribute/contributing/know-before-contribute.md#communication-channels) for questions if you're unsure how to create pull requests. An excellent tool to automate the infusion of starter kits in your repositories (especially if you have many) is to use a tool like [multi-gitter](https://github.com/lindell/multi-gitter) if you're using Git to create pull-requests.

Finally, if you use any of our guides - please consider adding the following badge to your `README.md`:
[![SLIM](https://img.shields.io/badge/Best%20Practices%20from-SLIM-blue)](https://nasa-ammos.github.io/slim/)

### Contribute to Our Guides

We'd be delighted to see your contribution! Please see our [Contributing Guide](docs/contribute/contributing) on details for how to contribute. We accept many non-code contributions as well, so feel free to think creatively.

### Join Our Community of Projects

Interested in becoming a part of the SLIM community? We welcome new project members who are keen on improving software lifecycle processes within their projects. Joining is simple:

1. **Publicly: Start a Discussion**: Head over to our [discussion forum](https://github.com/NASA-AMMOS/slim/discussions/new/choose) and file a new thread expressing your interest in joining SLIM. This is a great way to introduce your project and outline how you think SLIM could benefit you.

2. **Privately: Contact Us**: You can directly contact [@riverma](https://github.com/riverma) or the [@slim-steering](https://github.com/orgs/NASA-AMMOS/teams/slim-steering) group on GitHub to express your desire to join. We'll have a chat, and try to identify which repositories in your project make sense for best practice infusion as well as identify a point-of-contact.

Becoming a part of SLIM means not just receiving updates regarding our best practices and standards, but also receiving pull-requests and issue tickets that help streamline SLIM best practices more easily to your project (at no cost!).

### Spread the Word

The more people & projects using, contributing, and maintaining SLIM, the more robust and long-term this effort will last.

You can help by:

#### Socializing on GitHub

[⭐ Star our Repo](https://github.com/nasa-ammos/slim)

[👀 Watch our Repo](https://github.com/nasa-ammos/slim)

[😀 Discuss our Repo](https://github.com/nasa-ammos/slim)

#### Website

Share our website (https://nasa-ammos.github.io/slim) with your friends and colleagues
</ul>
52 changes: 52 additions & 0 deletions docs/join/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
# Join

SLIM best practice guides and recommendations are community generated, which means you can join our community!

Some ways you can get involved with SLIM:

## Use Our Guides

The fastest way to join the SLIM community is to start using our best practice guides in your project(s).

As you use our best practices, we always recommend working with your project by creating pull-requests. An excellent tool to automate the infusion of our best practices in your repositories (especially if you have many) is to use a tool like [multi-gitter](https://github.com/lindell/multi-gitter) if you're using Git to create pull-requests.

Some Pro ⭐️ tips:
- Add the following badge to your `README.md` so that your other team members can help:
[![SLIM](https://img.shields.io/badge/Best%20Practices%20from-SLIM-blue)](https://nasa-ammos.github.io/slim/)
- 👀 Watch our repo so you get updates on activities right away. In particular, ensure your notifications are set up to monitor our [Releases page](https://github.com/NASA-AMMOS/slim/releases) for key updates.

## Join Our Community of Projects

What does it mean to join the SLIM community as a member project? It means the SLIM project will reach out *to you* about new updates and best practices and offer automated pull-requests for select best practices to be sent to your project's repositories (at no cost!). We welcome new project members who are keen on improving software lifecycle processes within their projects.

For instance:
- See our current community members in our About page [here](/docs/about/#our-community-members).
- See an example of automated pull requests in-action for our community member repos [here](https://github.com/NASA-AMMOS/slim-leaderboard/blob/main/examples/slim-ammos-leaderboard.md).

Here's how you can tell us you're interested in joining:

1. **Publicly: Start a Discussion**: Head over to our [discussion forum](https://github.com/NASA-AMMOS/slim/discussions/new/choose) and file a new thread expressing your interest in joining SLIM. This is a great way to introduce your project and outline how you think SLIM could benefit you.

2. **Privately: Contact Us**: You can directly contact [@riverma](https://github.com/riverma) or the [@slim-steering](https://github.com/orgs/NASA-AMMOS/teams/slim-steering) group on GitHub to express your desire to join. We'll have a chat, and try to identify which repositories in your project make sense for best practice infusion as well as identify a point-of-contact.

## Contribute to Our Guides

We'd be delighted to see your contribution! Please see our [Contributing Guide](docs/contribute/contributing) on details for how to contribute. We accept many non-code contributions as well, so feel free to think creatively.

## Spread the Word

The more people & projects using, contributing, and maintaining SLIM, the more robust and long-term this effort will last.

You can help by:

### Socializing on GitHub

[⭐ Star our Repo](https://github.com/nasa-ammos/slim)

[👀 Watch our Repo](https://github.com/nasa-ammos/slim)

[😀 Discuss our Repo](https://github.com/nasa-ammos/slim)

### Website

Share our website (https://nasa-ammos.github.io/slim) with your friends and colleagues
10 changes: 10 additions & 0 deletions docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,12 @@ const config = {
position: 'left',
label: 'Contribute',
},
{
type: 'docSidebar',
sidebarId: 'joinSidebar',
position: 'left',
label: 'Join',
},
{
type: 'docSidebar',
sidebarId: 'aboutSidebar',
Expand Down Expand Up @@ -111,6 +117,10 @@ const config = {
label: 'Contribute',
to: '/docs/contribute/CONTRIBUTING',
},
{
label: 'Join',
to: '/docs/join/',
},
{
label: 'About',
to: '/docs/about',
Expand Down
3 changes: 2 additions & 1 deletion sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,8 @@ const sidebars = {
// By default, Docusaurus generates a sidebar from the docs folder structure
guidesSidebar: [{type: 'autogenerated', dirName: 'guides'}],
aboutSidebar: [{type: 'autogenerated', dirName: 'about'}],
contributeSidebar: [{type: 'autogenerated', dirName: 'contribute'}]
contributeSidebar: [{type: 'autogenerated', dirName: 'contribute'}],
joinSidebar: [{type: 'autogenerated', dirName: 'join'}]

// But you can create a sidebar manually
/*
Expand Down
Loading