From a1cf1aa813faf98ad6b773136a83445d31ade2f5 Mon Sep 17 00:00:00 2001 From: "Ferguson, Eric W (397B)" Date: Fri, 2 Aug 2024 15:30:41 -0700 Subject: [PATCH] Add definitions for project repo statuses. Add repo status to docs repo --- README.md | 2 ++ .../repositories/repos-introduction.mdx | 17 +++++++++++++++++ sidebars.js | 10 ++++++++++ 3 files changed, 29 insertions(+) create mode 100644 docs/ecosystem/repositories/repos-introduction.mdx diff --git a/README.md b/README.md index 5f20037..2607c5b 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,5 @@ # Aerie Documentation +[![Repo Status - Production](https://img.shields.io/badge/Repo_Status-Production-blue)](https://nasa-ammos.github.io/aerie-docs/ecosystem/repositories/repos-introduction/) + The main documentation site for Aerie. If you would like to contribute please see our [contributing guide](./CONTRIBUTING.md). diff --git a/docs/ecosystem/repositories/repos-introduction.mdx b/docs/ecosystem/repositories/repos-introduction.mdx new file mode 100644 index 0000000..8092c73 --- /dev/null +++ b/docs/ecosystem/repositories/repos-introduction.mdx @@ -0,0 +1,17 @@ +# Project Repositories + +Repositories within the Aerie project ecosystem are assigned a status (via a badge) to help set user expectations on the maturity and stability of the code within each repository. +These statuses and their definitions are below: + +[![Repo Status - Prototype](https://img.shields.io/badge/Repo_Status-Prototype-violet)](https://) - Intended to test out a new concept or design. Not intended as production code. Rapid development with no guaranteed stability and limited testing. + +[![Repo Status - Incubating](https://img.shields.io/badge/Repo_Status-Incubating-yellow)](https://) - Early stages of a repo eventually intended for production. Ongoing development with no guaranteed stability and limited testing. + +[![Repo Status - Development](https://img.shields.io/badge/Repo_Status-Development-brightgreen)](https://) - Middle stage of a repo working towards production. Active development with some testing and stability, but limited documentation. + +[![Repo Status - Production](https://img.shields.io/badge/Repo_Status-Production-blue)](https://) - Established repository with robust testing and documentation. Developers are building new releases, responding to issues, and integrating code contributions while maintaining stability with breaking changes noted in release notes. + +[![Repo Status - Not Maintained](https://img.shields.io/badge/Repo_Status-Not_Maintained-red)](https://) - Repository with no active development or maintenance to ensure compatibility with other project repositories. Still may have value to users or developers and could potentially be revived given additional resources or an identified need. + +[![Repo Status - Deprecated](https://img.shields.io/badge/Repo_Status-Deprecated-lightgrey)](https://) - Repository that has being phased out of production and no longer recommended for use + diff --git a/sidebars.js b/sidebars.js index 13a6c84..c5e4092 100644 --- a/sidebars.js +++ b/sidebars.js @@ -333,6 +333,16 @@ const sidebars = { }, ], }, + { + type: 'category', + label: 'Aerie Ecosystem', + link: { + type: 'generated-index', + }, + items: [ + 'ecosystem/repositories/repos-introduction' + ], + }, 'glossary', { label: 'Keyboard Shortcuts',