Skip to content

Commit b181518

Browse files
committed
New stand-alone join page
1 parent 9fab0e7 commit b181518

File tree

4 files changed

+67
-49
lines changed

4 files changed

+67
-49
lines changed

docs/about/README.md

+3-48
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@ sidebar_position: 1
1010

1111
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.
1212

13+
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.
14+
1315
## Our Focus
1416

1517
There are three key areas within the software development lifecycle improvement space that SLIM focuses on providing best practice guidance for:
@@ -75,51 +77,4 @@ The following list of public projects are currently SLIM community members:
7577
<li>Point of Contact: <a href="https://github.com/hookhua">@hookhua</a></li>
7678
</ul>
7779
</li>
78-
</ul>
79-
80-
## How To Get Involved
81-
82-
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.
83-
84-
Some ways you can get involved with SLIM:
85-
86-
### Use Our Guides
87-
88-
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.
89-
90-
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.
91-
92-
Finally, if you use any of our guides - please consider adding the following badge to your `README.md`:
93-
[![SLIM](https://img.shields.io/badge/Best%20Practices%20from-SLIM-blue)](https://nasa-ammos.github.io/slim/)
94-
95-
### Contribute to Our Guides
96-
97-
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.
98-
99-
### Join Our Community of Projects
100-
101-
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:
102-
103-
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.
104-
105-
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.
106-
107-
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!).
108-
109-
### Spread the Word
110-
111-
The more people & projects using, contributing, and maintaining SLIM, the more robust and long-term this effort will last.
112-
113-
You can help by:
114-
115-
#### Socializing on GitHub
116-
117-
[⭐ Star our Repo](https://github.com/nasa-ammos/slim)
118-
119-
[👀 Watch our Repo](https://github.com/nasa-ammos/slim)
120-
121-
[😀 Discuss our Repo](https://github.com/nasa-ammos/slim)
122-
123-
#### Website
124-
125-
Share our website (https://nasa-ammos.github.io/slim) with your friends and colleagues
80+
</ul>

docs/join/README.md

+52
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
# Join
2+
3+
SLIM best practice guides and recommendations are community generated, which means you can join our community!
4+
5+
Some ways you can get involved with SLIM:
6+
7+
## Use Our Guides
8+
9+
The fastest way to join the SLIM community is to start using our best practice guides in your project(s).
10+
11+
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.
12+
13+
Some Pro ⭐️ tips:
14+
- Add the following badge to your `README.md` so that your other team members can help:
15+
[![SLIM](https://img.shields.io/badge/Best%20Practices%20from-SLIM-blue)](https://nasa-ammos.github.io/slim/)
16+
- 👀 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.
17+
18+
## Join Our Community of Projects
19+
20+
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.
21+
22+
For instance:
23+
- See our current community members in our About page [here](/docs/about/#our-community-members).
24+
- 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).
25+
26+
Here's how you can tell us you're interested in joining:
27+
28+
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.
29+
30+
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.
31+
32+
## Contribute to Our Guides
33+
34+
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.
35+
36+
## Spread the Word
37+
38+
The more people & projects using, contributing, and maintaining SLIM, the more robust and long-term this effort will last.
39+
40+
You can help by:
41+
42+
### Socializing on GitHub
43+
44+
[⭐ Star our Repo](https://github.com/nasa-ammos/slim)
45+
46+
[👀 Watch our Repo](https://github.com/nasa-ammos/slim)
47+
48+
[😀 Discuss our Repo](https://github.com/nasa-ammos/slim)
49+
50+
### Website
51+
52+
Share our website (https://nasa-ammos.github.io/slim) with your friends and colleagues

docusaurus.config.js

+10
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,12 @@ const config = {
8484
position: 'left',
8585
label: 'Contribute',
8686
},
87+
{
88+
type: 'docSidebar',
89+
sidebarId: 'joinSidebar',
90+
position: 'left',
91+
label: 'Join',
92+
},
8793
{
8894
type: 'docSidebar',
8995
sidebarId: 'aboutSidebar',
@@ -111,6 +117,10 @@ const config = {
111117
label: 'Contribute',
112118
to: '/docs/contribute/CONTRIBUTING',
113119
},
120+
{
121+
label: 'Join',
122+
to: '/docs/join/',
123+
},
114124
{
115125
label: 'About',
116126
to: '/docs/about',

sidebars.js

+2-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,8 @@ const sidebars = {
1616
// By default, Docusaurus generates a sidebar from the docs folder structure
1717
guidesSidebar: [{type: 'autogenerated', dirName: 'guides'}],
1818
aboutSidebar: [{type: 'autogenerated', dirName: 'about'}],
19-
contributeSidebar: [{type: 'autogenerated', dirName: 'contribute'}]
19+
contributeSidebar: [{type: 'autogenerated', dirName: 'contribute'}],
20+
joinSidebar: [{type: 'autogenerated', dirName: 'join'}]
2021

2122
// But you can create a sidebar manually
2223
/*

0 commit comments

Comments
 (0)