From 6343bd65bbb73f63c1bbf733cb7ead0e0a6551e6 Mon Sep 17 00:00:00 2001
From: Verena Chung <9377970+vpchung@users.noreply.github.com>
Date: Tue, 13 Feb 2024 09:14:31 -0800
Subject: [PATCH] fix(openchallenges): restructure docs site (#2441)
---
docs/{ => _archive}/angular-universal.md | 0
.../app-styles-themes-assets.md | 0
docs/{ => _archive}/changelog.md | 0
docs/{ => _archive}/cheat-sheet.md | 0
...llect-challenge-logs-and-system-metrics.md | 0
docs/{ => _archive}/coverage.md | 0
.../create-a-new-angular-component.md | 0
docs/{ => _archive}/devcontainer.md | 0
.../develop-on-a-remote-host.md | 0
docs/{ => _archive}/developing-in-python.md | 0
.../enable-sso-with-keycloak.md | 0
docs/{ => _archive}/faq.md | 0
docs/{ => _archive}/figma-to-code.md | 0
docs/_archive/index.md | 65 +++++++++++++++
docs/{ => _archive}/java-cheat-sheet.md | 0
docs/{ => _archive}/legacy-repositories.md | 0
docs/{ => _archive}/libraries.md | 0
docs/{ => _archive}/linters-and-formatters.md | 0
docs/{ => _archive}/nx-readme.md | 0
docs/{ => _archive}/nx-tags.md | 0
docs/{ => _archive}/projects.md | 0
docs/{ => _archive}/references.md | 0
.../search-engine-optimization.md | 0
docs/{ => _archive}/stack-monitoring.md | 0
docs/{ => _archive}/update-dependencies.md | 0
docs/{ => _archive}/using-nx.md | 0
docs/{ => _archive}/vscode-cheat-sheet.md | 0
docs/bug-report.md | 9 --
docs/code-of-conduct.md | 5 --
docs/contributing-guidelines.md | 23 ------
docs/contributions/bug-report.md | 8 ++
.../guidelines.md} | 0
docs/contributions/overview.md | 14 ++++
docs/developers-guide/faq.md | 1 +
docs/getting-started/local-dev.md | 1 +
docs/getting-started/remote-dev.md | 1 +
docs/getting-started/what-is-angular.md | 1 +
docs/getting-started/what-is-devcontainer.md | 1 +
docs/getting-started/what-is-nx.md | 1 +
docs/index.md | 82 +++++--------------
docs/news.md | 25 ++++++
docs/reference/agora.md | 1 +
docs/reference/oc-microservices.md | 1 +
docs/reference/oc-schemas.md | 1 +
docs/reference/schematic.md | 1 +
docs/tutorials/angular/add-api-client.md | 1 +
docs/tutorials/angular/add-app.md | 1 +
docs/tutorials/angular/add-component.md | 1 +
docs/tutorials/angular/add-library.md | 1 +
docs/tutorials/docker/new-project.md | 1 +
docs/tutorials/java/add-library.md | 1 +
docs/tutorials/java/add-rest-api.md | 1 +
docs/tutorials/python/add-rest-api.md | 1 +
docs/tutorials/r/new-project.md | 1 +
mkdocs.yml | 69 +++++++++-------
55 files changed, 192 insertions(+), 127 deletions(-)
rename docs/{ => _archive}/angular-universal.md (100%)
rename docs/{ => _archive}/app-styles-themes-assets.md (100%)
rename docs/{ => _archive}/changelog.md (100%)
rename docs/{ => _archive}/cheat-sheet.md (100%)
rename docs/{ => _archive}/collect-challenge-logs-and-system-metrics.md (100%)
rename docs/{ => _archive}/coverage.md (100%)
rename docs/{ => _archive}/create-a-new-angular-component.md (100%)
rename docs/{ => _archive}/devcontainer.md (100%)
rename docs/{ => _archive}/develop-on-a-remote-host.md (100%)
rename docs/{ => _archive}/developing-in-python.md (100%)
rename docs/{ => _archive}/enable-sso-with-keycloak.md (100%)
rename docs/{ => _archive}/faq.md (100%)
rename docs/{ => _archive}/figma-to-code.md (100%)
create mode 100644 docs/_archive/index.md
rename docs/{ => _archive}/java-cheat-sheet.md (100%)
rename docs/{ => _archive}/legacy-repositories.md (100%)
rename docs/{ => _archive}/libraries.md (100%)
rename docs/{ => _archive}/linters-and-formatters.md (100%)
rename docs/{ => _archive}/nx-readme.md (100%)
rename docs/{ => _archive}/nx-tags.md (100%)
rename docs/{ => _archive}/projects.md (100%)
rename docs/{ => _archive}/references.md (100%)
rename docs/{ => _archive}/search-engine-optimization.md (100%)
rename docs/{ => _archive}/stack-monitoring.md (100%)
rename docs/{ => _archive}/update-dependencies.md (100%)
rename docs/{ => _archive}/using-nx.md (100%)
rename docs/{ => _archive}/vscode-cheat-sheet.md (100%)
delete mode 100644 docs/bug-report.md
delete mode 100644 docs/code-of-conduct.md
delete mode 100644 docs/contributing-guidelines.md
create mode 100644 docs/contributions/bug-report.md
rename docs/{contributing.md => contributions/guidelines.md} (100%)
create mode 100644 docs/contributions/overview.md
create mode 100644 docs/developers-guide/faq.md
create mode 100644 docs/getting-started/local-dev.md
create mode 100644 docs/getting-started/remote-dev.md
create mode 100644 docs/getting-started/what-is-angular.md
create mode 100644 docs/getting-started/what-is-devcontainer.md
create mode 100644 docs/getting-started/what-is-nx.md
create mode 100644 docs/news.md
create mode 100644 docs/reference/agora.md
create mode 100644 docs/reference/oc-microservices.md
create mode 100644 docs/reference/oc-schemas.md
create mode 100644 docs/reference/schematic.md
create mode 100644 docs/tutorials/angular/add-api-client.md
create mode 100644 docs/tutorials/angular/add-app.md
create mode 100644 docs/tutorials/angular/add-component.md
create mode 100644 docs/tutorials/angular/add-library.md
create mode 100644 docs/tutorials/docker/new-project.md
create mode 100644 docs/tutorials/java/add-library.md
create mode 100644 docs/tutorials/java/add-rest-api.md
create mode 100644 docs/tutorials/python/add-rest-api.md
create mode 100644 docs/tutorials/r/new-project.md
diff --git a/docs/angular-universal.md b/docs/_archive/angular-universal.md
similarity index 100%
rename from docs/angular-universal.md
rename to docs/_archive/angular-universal.md
diff --git a/docs/app-styles-themes-assets.md b/docs/_archive/app-styles-themes-assets.md
similarity index 100%
rename from docs/app-styles-themes-assets.md
rename to docs/_archive/app-styles-themes-assets.md
diff --git a/docs/changelog.md b/docs/_archive/changelog.md
similarity index 100%
rename from docs/changelog.md
rename to docs/_archive/changelog.md
diff --git a/docs/cheat-sheet.md b/docs/_archive/cheat-sheet.md
similarity index 100%
rename from docs/cheat-sheet.md
rename to docs/_archive/cheat-sheet.md
diff --git a/docs/collect-challenge-logs-and-system-metrics.md b/docs/_archive/collect-challenge-logs-and-system-metrics.md
similarity index 100%
rename from docs/collect-challenge-logs-and-system-metrics.md
rename to docs/_archive/collect-challenge-logs-and-system-metrics.md
diff --git a/docs/coverage.md b/docs/_archive/coverage.md
similarity index 100%
rename from docs/coverage.md
rename to docs/_archive/coverage.md
diff --git a/docs/create-a-new-angular-component.md b/docs/_archive/create-a-new-angular-component.md
similarity index 100%
rename from docs/create-a-new-angular-component.md
rename to docs/_archive/create-a-new-angular-component.md
diff --git a/docs/devcontainer.md b/docs/_archive/devcontainer.md
similarity index 100%
rename from docs/devcontainer.md
rename to docs/_archive/devcontainer.md
diff --git a/docs/develop-on-a-remote-host.md b/docs/_archive/develop-on-a-remote-host.md
similarity index 100%
rename from docs/develop-on-a-remote-host.md
rename to docs/_archive/develop-on-a-remote-host.md
diff --git a/docs/developing-in-python.md b/docs/_archive/developing-in-python.md
similarity index 100%
rename from docs/developing-in-python.md
rename to docs/_archive/developing-in-python.md
diff --git a/docs/enable-sso-with-keycloak.md b/docs/_archive/enable-sso-with-keycloak.md
similarity index 100%
rename from docs/enable-sso-with-keycloak.md
rename to docs/_archive/enable-sso-with-keycloak.md
diff --git a/docs/faq.md b/docs/_archive/faq.md
similarity index 100%
rename from docs/faq.md
rename to docs/_archive/faq.md
diff --git a/docs/figma-to-code.md b/docs/_archive/figma-to-code.md
similarity index 100%
rename from docs/figma-to-code.md
rename to docs/_archive/figma-to-code.md
diff --git a/docs/_archive/index.md b/docs/_archive/index.md
new file mode 100644
index 0000000000..05a87d48a2
--- /dev/null
+++ b/docs/_archive/index.md
@@ -0,0 +1,65 @@
+
+
+- [Overview of Sage Monorepo]
+- Cheat Sheet (coming soon)
+- [Docs](docs)
+
+## Development Setup
+
+### Requirements
+
+- [Docker Engine] OR [GitHub Codespace]
+- [Visual Studio Code]
+
+### Open Sage Monorepo in VS Code
+
+**Option 1**: Click on the button shown below to open Sage Monorepo in its [development container]
+with VS Code. This option is suitable if you want to explore the content of Sage Monorepo.
+
+[](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/Sage-Bionetworks/sage-monorepo 'Open in VS Code Dev Containers')
+
+**Option 2**: If you plan to contribute to this project, please [create a fork] and use its URL for
+cloning. For more information on contributing and/or our Forking Workflow, see
+[CONTRIBUTING.md](CONTRIBUTING.md).
+
+<!-- termynal -->
+```console
+$ git clone --filter=blob:none <fork url>
+---> 100%
+Resolving deltas: 100% (...), done.
+```
+
+Then open your fork repo inside our dev container using these instructions:
+
+- [Developing inside a Container](./docs/devcontainer.md)
+- [Develop on a remote host](./docs/develop-on-a-remote-host.md) (optional)
+
+## Ecosystem
+
+- Java
+- Node.js
+- Python
+- R
+
+
+## Projects
+
+- OpenChallenges
+- Schematic (evaluation)
+- Synapse (evaluation)
+
+---
+
+Love Sage Monorepo and its projects? Give our repo a star ⭐.
+
+<!-- Links -->
+
+[docker engine]: https://docs.docker.com/get-docker/
+[visual studio code]: https://code.visualstudio.com/
+[apache license 2.0]: https://github.com/Sage-Bionetworks/sage-monorepo/blob/main/LICENSE.txt
+[GitHub Codespace]: https://github.com/features/codespaces
+[Overview of Sage Monorepo]: https://docs.google.com/document/d/12oA-Uol_NsWUtC9LHlAlpcgZXXY9jkxFXqK2EMF96XM
+[Code of Conduct]: CODE_OF_CONDUCT.md
+[contributing]: CONTRIBUTING.md
+[development container]: https://containers.dev/
+[create a fork]: https://github.com/Sage-Bionetworks/sage-monorepo/fork
diff --git a/docs/java-cheat-sheet.md b/docs/_archive/java-cheat-sheet.md
similarity index 100%
rename from docs/java-cheat-sheet.md
rename to docs/_archive/java-cheat-sheet.md
diff --git a/docs/legacy-repositories.md b/docs/_archive/legacy-repositories.md
similarity index 100%
rename from docs/legacy-repositories.md
rename to docs/_archive/legacy-repositories.md
diff --git a/docs/libraries.md b/docs/_archive/libraries.md
similarity index 100%
rename from docs/libraries.md
rename to docs/_archive/libraries.md
diff --git a/docs/linters-and-formatters.md b/docs/_archive/linters-and-formatters.md
similarity index 100%
rename from docs/linters-and-formatters.md
rename to docs/_archive/linters-and-formatters.md
diff --git a/docs/nx-readme.md b/docs/_archive/nx-readme.md
similarity index 100%
rename from docs/nx-readme.md
rename to docs/_archive/nx-readme.md
diff --git a/docs/nx-tags.md b/docs/_archive/nx-tags.md
similarity index 100%
rename from docs/nx-tags.md
rename to docs/_archive/nx-tags.md
diff --git a/docs/projects.md b/docs/_archive/projects.md
similarity index 100%
rename from docs/projects.md
rename to docs/_archive/projects.md
diff --git a/docs/references.md b/docs/_archive/references.md
similarity index 100%
rename from docs/references.md
rename to docs/_archive/references.md
diff --git a/docs/search-engine-optimization.md b/docs/_archive/search-engine-optimization.md
similarity index 100%
rename from docs/search-engine-optimization.md
rename to docs/_archive/search-engine-optimization.md
diff --git a/docs/stack-monitoring.md b/docs/_archive/stack-monitoring.md
similarity index 100%
rename from docs/stack-monitoring.md
rename to docs/_archive/stack-monitoring.md
diff --git a/docs/update-dependencies.md b/docs/_archive/update-dependencies.md
similarity index 100%
rename from docs/update-dependencies.md
rename to docs/_archive/update-dependencies.md
diff --git a/docs/using-nx.md b/docs/_archive/using-nx.md
similarity index 100%
rename from docs/using-nx.md
rename to docs/_archive/using-nx.md
diff --git a/docs/vscode-cheat-sheet.md b/docs/_archive/vscode-cheat-sheet.md
similarity index 100%
rename from docs/vscode-cheat-sheet.md
rename to docs/_archive/vscode-cheat-sheet.md
diff --git a/docs/bug-report.md b/docs/bug-report.md
deleted file mode 100644
index 10394f16d6..0000000000
--- a/docs/bug-report.md
+++ /dev/null
@@ -1,9 +0,0 @@
-Issues should be used to report problems with this project, request a new
-feature, or to discuss potential changes before a PR is created. When you create
-a new Issue, a template will be loaded that will guide you through collecting
-and providing the information we need to investigate.
-
-If you find an Issue that addresses the problem you're having, please add your
-own reproduction information to the existing issue rather than creating a new
-one. Adding a [reaction] can also help be indicating to our maintainers that a
-particular problem is affecting more than just the reporter.
diff --git a/docs/code-of-conduct.md b/docs/code-of-conduct.md
deleted file mode 100644
index f0042a38a8..0000000000
--- a/docs/code-of-conduct.md
+++ /dev/null
@@ -1,5 +0,0 @@
-We take our open source community seriously and hold ourselves and other
-contributors to high standards of communication. By participating and
-contributing to this project, you agree to uphold our [Code of Conduct].
-
-[Code of Conduct]: CODE-OF-CONDUCT.md
\ No newline at end of file
diff --git a/docs/contributing-guidelines.md b/docs/contributing-guidelines.md
deleted file mode 100644
index 1b77390d27..0000000000
--- a/docs/contributing-guidelines.md
+++ /dev/null
@@ -1,23 +0,0 @@
-A big welcome and thank you for considering contributing to this project.
-
-This project is a community effort and lives off your contributions, be it in
-the form of bug reports, feature requests, discussions, or fixes and other code
-changes.
-
-Reading and following these guidelines will help us make the contribution
-process easy and effective for everyone involved. It also communicates that you
-agree to respect the time of the developers managing and developing these open
-source projects. In return, we will reciprocate that respect by addressing your
-issue, assessing changes, and helping you finalize your pull requests.
-
-
-## Getting Started
-
-Contributions are made to this repo via Issues and Pull Requests (PRs). A few
-general guidelines that cover both:
-
-- Search for existing Issues and PRs before creating your own.
-- We work hard to makes sure issues are handled in a timely manner but,
- depending on the impact, it could take a while to investigate the root cause.
- A friendly ping in the comment thread to the submitter or a contributor can
- help draw attention if your issue is blocking.
diff --git a/docs/contributions/bug-report.md b/docs/contributions/bug-report.md
new file mode 100644
index 0000000000..788de09327
--- /dev/null
+++ b/docs/contributions/bug-report.md
@@ -0,0 +1,8 @@
+Issues should be used to report problems with this project, request a new feature, or to discuss
+potential changes before a pull request (PR) is created. When you create a new issue, a template
+will be loaded that will guide you through collecting and providing the information we need to
+investigate.
+
+If you find an issue that addresses the problem you're having, please add your own reproduction
+information to the existing issue rather than creating a new one. Adding a reaction can also help
+be indicating to our maintainers that a particular problem is affecting more than just the reporter.
diff --git a/docs/contributing.md b/docs/contributions/guidelines.md
similarity index 100%
rename from docs/contributing.md
rename to docs/contributions/guidelines.md
diff --git a/docs/contributions/overview.md b/docs/contributions/overview.md
new file mode 100644
index 0000000000..c6f8ce706b
--- /dev/null
+++ b/docs/contributions/overview.md
@@ -0,0 +1,14 @@
+Thank you contributing to the Sage Monorepo! We welcome any and all feedback, ideas, and
+suggestions.
+
+Contributions can be made via issues and pull eequests (PRs).
+
+* [Reporting a bug](/bug-report)
+* [Adding a feature](/contributing)
+
+
+### Code of Conduct
+
+We take our open source community seriously and hold ourselves and other contributors to high
+standards of communication. By participating and contributing to this project, you agree to uphold
+our [Code of Conduct](https://github.com/Sage-Bionetworks/sage-monorepo/blob/main/CODE_OF_CONDUCT.md).
\ No newline at end of file
diff --git a/docs/developers-guide/faq.md b/docs/developers-guide/faq.md
new file mode 100644
index 0000000000..7f8533d100
--- /dev/null
+++ b/docs/developers-guide/faq.md
@@ -0,0 +1 @@
+!!!note "Content coming soon!"
diff --git a/docs/getting-started/local-dev.md b/docs/getting-started/local-dev.md
new file mode 100644
index 0000000000..57c3da809d
--- /dev/null
+++ b/docs/getting-started/local-dev.md
@@ -0,0 +1 @@
+!!!note "Content comming soon!"
diff --git a/docs/getting-started/remote-dev.md b/docs/getting-started/remote-dev.md
new file mode 100644
index 0000000000..57c3da809d
--- /dev/null
+++ b/docs/getting-started/remote-dev.md
@@ -0,0 +1 @@
+!!!note "Content comming soon!"
diff --git a/docs/getting-started/what-is-angular.md b/docs/getting-started/what-is-angular.md
new file mode 100644
index 0000000000..1241aa0fcd
--- /dev/null
+++ b/docs/getting-started/what-is-angular.md
@@ -0,0 +1 @@
+!!!note "Content comming soon!"
\ No newline at end of file
diff --git a/docs/getting-started/what-is-devcontainer.md b/docs/getting-started/what-is-devcontainer.md
new file mode 100644
index 0000000000..57c3da809d
--- /dev/null
+++ b/docs/getting-started/what-is-devcontainer.md
@@ -0,0 +1 @@
+!!!note "Content comming soon!"
diff --git a/docs/getting-started/what-is-nx.md b/docs/getting-started/what-is-nx.md
new file mode 100644
index 0000000000..57c3da809d
--- /dev/null
+++ b/docs/getting-started/what-is-nx.md
@@ -0,0 +1 @@
+!!!note "Content comming soon!"
diff --git a/docs/index.md b/docs/index.md
index d74a361692..2d7e88db04 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -1,72 +1,34 @@
-
+
-<img src="https://img.shields.io/github/actions/workflow/status/Sage-Bionetworks/sage-monorepo/ci.yml?branch=main&color=007acc&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github&label=CI/CD" alt="Sage Monorepo CI/CD" />
-<img src="https://img.shields.io/github/license/Sage-Bionetworks/sage-monorepo.svg?color=007acc&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github)](https://github.com/Sage-Bionetworks/sage-monorepo/blob/main/LICENSE" alt="Sage Monorepo License" />
+# Sage Monorepo
+_Build robust apps faster_
---
-Get started with Sage Monorepo, learn the fundamentals and explore advanced topics.
-
-- [Overview of Sage Monorepo]
-- Cheat Sheet (coming soon)
-- [Docs](docs)
-
-## Development Setup
-
-### Requirements
-
-- [Docker Engine] OR [GitHub Codespace]
-- [Visual Studio Code]
-
-### Open Sage Monorepo in VS Code
-
-**Option 1**: Click on the button shown below to open Sage Monorepo in its [development container]
-with VS Code. This option is suitable if you want to explore the content of Sage Monorepo.
-
-[](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/Sage-Bionetworks/sage-monorepo 'Open in VS Code Dev Containers')
-
-**Option 2**: If you plan to contribute to this project, please [create a fork] and use its URL for
-cloning. For more information on contributing and/or our Forking Workflow, see
-[CONTRIBUTING.md](CONTRIBUTING.md).
-
-<!-- termynal -->
-```console
-$ git clone --filter=blob:none <fork url>
----> 100%
-Resolving deltas: 100% (...), done.
-```
-
-Then open your fork repo inside our dev container using these instructions:
-
-- [Developing inside a Container](./docs/devcontainer.md)
-- [Develop on a remote host](./docs/develop-on-a-remote-host.md) (optional)
-
-## Ecosystem
+<img src="https://img.shields.io/github/actions/workflow/status/Sage-Bionetworks/sage-monorepo/ci.yml?branch=main&color=007acc&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github&label=CI/CD" alt="Sage Monorepo CI/CD" />
+<img src="https://img.shields.io/github/license/Sage-Bionetworks/sage-monorepo.svg?color=007acc&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github)](https://github.com/Sage-Bionetworks/sage-monorepo/blob/main/LICENSE" alt="Sage Monorepo License" />
-- Java
-- Node.js
-- Python
-- R
+---
+Developers building components in silos can lead to a number of problems, including duplicated
+components, increased maintenance, and reduced visibility.
-## Projects
+Sage Monorepo addresses these problems by providing a centralized repository for standardized,
+reusable components. This solution also improves the developer experience (DX), which can lead to
+increased morale, productivity, retention, and knowledge transfer.
-- OpenChallenges
-- Schematic (evaluation)
-- Synapse (evaluation)
+## Key Features
----
+* Build apps faster
+* Use latest technologies
+* Open-source
-Love Sage Monorepo and its projects? Give our repo a star ⭐.
-<!-- Links -->
+## Current Projects
-[docker engine]: https://docs.docker.com/get-docker/
-[visual studio code]: https://code.visualstudio.com/
-[apache license 2.0]: https://github.com/Sage-Bionetworks/sage-monorepo/blob/main/LICENSE.txt
-[GitHub Codespace]: https://github.com/features/codespaces
-[Overview of Sage Monorepo]: https://docs.google.com/document/d/12oA-Uol_NsWUtC9LHlAlpcgZXXY9jkxFXqK2EMF96XM
-[Code of Conduct]: CODE_OF_CONDUCT.md
-[contributing]: CONTRIBUTING.md
-[development container]: https://containers.dev/
-[create a fork]: https://github.com/Sage-Bionetworks/sage-monorepo/fork
+Name | Description
+--|--
+[Agora](https://agora.adknowledgeportal.org/genes) | Agora hosts high-dimensional human transcriptomic, proteomic, and metabolomic evidence for whether or not genes are associated with Alzheimer’s disease (AD).
+[iAtlas](https://isb-cgc.shinyapps.io/iatlas/) | The iAtlas portal serves as an interactive tool for exploring and analyzing immuno-oncology data.
+[OpenChallenges](https://openchallenges.io/home) | OpenChallenges (OC) aggregates biomedical challenges to accelerate citizen science and data benchmarking
+[Schematic](https://github.com/Sage-Bionetworks/schematic) | SCHEMATIC (Schema Engine for Manifest Ingress and Curation) is a novel schema-based, metadata ingress ecosystem, meant to streamline the process of biomedical dataset annotation, metadata validation and submission to a data repository for various data contributors.
diff --git a/docs/news.md b/docs/news.md
new file mode 100644
index 0000000000..93828debb5
--- /dev/null
+++ b/docs/news.md
@@ -0,0 +1,25 @@
+## General
+
+### Jan 2024
+
+We're kicking off the new year with our new-and-improved docs site! We are continuously looking
+to improve, so if you have any feedback, [please us know](https://github.com/Sage-Bionetworks/sage-monorepo/issues/new?assignees=&labels=type%3A+docs&projects=&template=3-documentation.yml&title=%5BDocs%5D+%3Ctitle%3E)!
+
+### Sept 2023
+
+Introducing a new product we support: [Agora](https://agora.adknowledgeportal.org/genes)!
+
+### June 2023
+
+We now support the schematic API! [Check them out](https://schematicpy.readthedocs.io/en/latest/cli_reference.html).
+
+### Jan 2023
+
+Kicking off the Sage Monorepo with our first product: [OpenChallenges](https://openchallenges.io/home)
+
+## Agora
+
+## OpenChallenges
+
+## Schematic
+
diff --git a/docs/reference/agora.md b/docs/reference/agora.md
new file mode 100644
index 0000000000..7f8533d100
--- /dev/null
+++ b/docs/reference/agora.md
@@ -0,0 +1 @@
+!!!note "Content coming soon!"
diff --git a/docs/reference/oc-microservices.md b/docs/reference/oc-microservices.md
new file mode 100644
index 0000000000..7f8533d100
--- /dev/null
+++ b/docs/reference/oc-microservices.md
@@ -0,0 +1 @@
+!!!note "Content coming soon!"
diff --git a/docs/reference/oc-schemas.md b/docs/reference/oc-schemas.md
new file mode 100644
index 0000000000..7f8533d100
--- /dev/null
+++ b/docs/reference/oc-schemas.md
@@ -0,0 +1 @@
+!!!note "Content coming soon!"
diff --git a/docs/reference/schematic.md b/docs/reference/schematic.md
new file mode 100644
index 0000000000..7f8533d100
--- /dev/null
+++ b/docs/reference/schematic.md
@@ -0,0 +1 @@
+!!!note "Content coming soon!"
diff --git a/docs/tutorials/angular/add-api-client.md b/docs/tutorials/angular/add-api-client.md
new file mode 100644
index 0000000000..49403273b0
--- /dev/null
+++ b/docs/tutorials/angular/add-api-client.md
@@ -0,0 +1 @@
+!!!note "Content coming soon!"
\ No newline at end of file
diff --git a/docs/tutorials/angular/add-app.md b/docs/tutorials/angular/add-app.md
new file mode 100644
index 0000000000..7f8533d100
--- /dev/null
+++ b/docs/tutorials/angular/add-app.md
@@ -0,0 +1 @@
+!!!note "Content coming soon!"
diff --git a/docs/tutorials/angular/add-component.md b/docs/tutorials/angular/add-component.md
new file mode 100644
index 0000000000..49403273b0
--- /dev/null
+++ b/docs/tutorials/angular/add-component.md
@@ -0,0 +1 @@
+!!!note "Content coming soon!"
\ No newline at end of file
diff --git a/docs/tutorials/angular/add-library.md b/docs/tutorials/angular/add-library.md
new file mode 100644
index 0000000000..49403273b0
--- /dev/null
+++ b/docs/tutorials/angular/add-library.md
@@ -0,0 +1 @@
+!!!note "Content coming soon!"
\ No newline at end of file
diff --git a/docs/tutorials/docker/new-project.md b/docs/tutorials/docker/new-project.md
new file mode 100644
index 0000000000..7f8533d100
--- /dev/null
+++ b/docs/tutorials/docker/new-project.md
@@ -0,0 +1 @@
+!!!note "Content coming soon!"
diff --git a/docs/tutorials/java/add-library.md b/docs/tutorials/java/add-library.md
new file mode 100644
index 0000000000..7f8533d100
--- /dev/null
+++ b/docs/tutorials/java/add-library.md
@@ -0,0 +1 @@
+!!!note "Content coming soon!"
diff --git a/docs/tutorials/java/add-rest-api.md b/docs/tutorials/java/add-rest-api.md
new file mode 100644
index 0000000000..7f8533d100
--- /dev/null
+++ b/docs/tutorials/java/add-rest-api.md
@@ -0,0 +1 @@
+!!!note "Content coming soon!"
diff --git a/docs/tutorials/python/add-rest-api.md b/docs/tutorials/python/add-rest-api.md
new file mode 100644
index 0000000000..8b13789179
--- /dev/null
+++ b/docs/tutorials/python/add-rest-api.md
@@ -0,0 +1 @@
+
diff --git a/docs/tutorials/r/new-project.md b/docs/tutorials/r/new-project.md
new file mode 100644
index 0000000000..7f8533d100
--- /dev/null
+++ b/docs/tutorials/r/new-project.md
@@ -0,0 +1 @@
+!!!note "Content coming soon!"
diff --git a/mkdocs.yml b/mkdocs.yml
index 8fe7d72c27..55767c9c7c 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -9,36 +9,45 @@ repo_name: sage-monorepo
# Navigation
nav:
- - Home:
- - Home: index.md
- - Changelog: changelog.md
+ - Home:
+ - Sage Monorepo: index.md
+ - What's new: news.md
- Contributing:
- - Overview: contributing-guidelines.md
- - Reporting a bug: bug-report.md
- - Adding a feature: contributing.md
- - Code of conduct: code-of-conduct.md
+ - Overview: contributions/overview.md
+ - Reporting a bug: contributions/bug-report.md
+ - Adding a feature: contributions/guidelines.md
- Getting Started:
- - Angular Universal: angular-universal.md
- - Devcontainer: devcontainer.md
- - Nx: using-nx.md
- - Remote host: develop-on-a-remote-host.md
- - Setup:
- - Figma-to-Code: figma-to-code.md
- - Using styles/themes: app-styles-themes-assets.md
- - Create a new library: libraries.md
- - Create a new component: create-a-new-angular-component.md
- - Monitor the stack: stack-monitoring.md
- - Collect logs and system metrics: collect-challenge-logs-and-system-metrics.md
- - Update tools and dependencies: update-dependencies.md
- - Code coverage: coverage.md
- - Cheat Sheets:
- - VSCode: vscode-cheat-sheet.md
- - Java: java-cheat-sheed.md
- - OpenChallenges: cheat-sheet.md
- - References:
- - references.md
- - Linters and formatters: linters-and-formatters.md
- - FAQ: faq.md
+ - What is Angular Universal?: getting-started/what-is-angular.md
+ - What is a devcontainer?: getting-started/what-is-devcontainer.md
+ - What is Nx?: getting-started/what-is-nx.md
+ - Setup:
+ - Develop Locally: getting-started/local-dev.md
+ - Develop On a Remote Host: getting-started/remote-dev.md
+ - Tutorials:
+ - Angular:
+ - Create an Angular app: tutorials/angular/add-app.md
+ - Add an Angular API client: tutorials/angular/add-api-client.md
+ - Add an Angular component: tutorials/angular/add-component.md
+ - Add an Angular library: tutorials/angular/add-library.md
+ - Docker:
+ - Create a Docker-based project: tutorials/docker/new-project.md
+ - Java:
+ - Add a Java library: tutorials/java/add-library.md
+ - Add a Java REST API: tutorials/java/add-rest-api.md
+ - Python:
+ - Add a Python REST API: tutorials/python/add-rest-api.md
+ - R:
+ - Add an R project: tutorials/r/new-project.md
+ - Developers Guide:
+ - Common Issues: developers-guide/faq.md
+ - Reference:
+ - Agora:
+ - API: reference/agora.md
+ - OpenChallenges:
+ - Microservices: reference/oc-microservices.md
+ - Schemas: reference/oc-schemas.md
+ - Schematic:
+ - API: reference/schematic.md
# Theme configuration
theme:
@@ -46,13 +55,13 @@ theme:
palette:
- media: "(prefers-color-scheme: light)"
scheme: default
- primary: teal
+ primary: blue
toggle:
icon: material/toggle-switch-off-outline
name: Switch to dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
- primary: deep purple
+ primary: blue
toggle:
icon: material/toggle-switch
name: Switch to light mode