feat(mkdocs): enable auto navigation by removing the nac section from mkdocs.yaml
This commit is contained in:
parent
ad8bfcd1b3
commit
9a3f17ec02
3 changed files with 12 additions and 77 deletions
|
|
@ -1,6 +1,6 @@
|
||||||
# Backstage docs local
|
# Backstage docs local
|
||||||
|
|
||||||
Take this repo when you want to start editing documentation for Backstage techdocs independently from a central docs repo.
|
Take this repo and run a local Backstage harness when you want to edit documentation independently of a central docs repo.
|
||||||
|
|
||||||
For the PoC doc you first can *prepare* your docs here.
|
For the PoC doc you first can *prepare* your docs here.
|
||||||
Later on they will go into a central docs repo.
|
Later on they will go into a central docs repo.
|
||||||
|
|
@ -15,10 +15,12 @@ You need nodejs and npx.
|
||||||
If you need a devboxed nodejs environment, have [devbox installed](https://www.jetify.com/docs/devbox/installing_devbox/). Then run
|
If you need a devboxed nodejs environment, have [devbox installed](https://www.jetify.com/docs/devbox/installing_devbox/). Then run
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
|
# in this folder
|
||||||
|
|
||||||
devbox shell
|
devbox shell
|
||||||
```
|
```
|
||||||
|
|
||||||
When npx is available, run
|
Now npx is available, next run
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# in the repo root dir
|
# in the repo root dir
|
||||||
|
|
@ -26,10 +28,15 @@ When npx is available, run
|
||||||
# use backstage theme and frame
|
# use backstage theme and frame
|
||||||
npx @techdocs/cli serve
|
npx @techdocs/cli serve
|
||||||
|
|
||||||
|
# hint: add 'npx --force --libc=glibc' if the nodejs install hangs
|
||||||
|
# npx --verbose --force --libc=glibc @techdocs/cli serve
|
||||||
|
|
||||||
#use mkdocs theme
|
#use mkdocs theme
|
||||||
npx @techdocs/cli serve:mkdocs
|
npx @techdocs/cli serve:mkdocs
|
||||||
```
|
```
|
||||||
|
|
||||||
|
and you will get
|
||||||
|
|
||||||
### Output
|
### Output
|
||||||
|
|
||||||
You should see this screen:
|
You should see this screen:
|
||||||
|
|
|
||||||
|
|
@ -1,6 +1,9 @@
|
||||||
{
|
{
|
||||||
"lockfile_version": "1",
|
"lockfile_version": "1",
|
||||||
"packages": {
|
"packages": {
|
||||||
|
"github:NixOS/nixpkgs/nixpkgs-unstable": {
|
||||||
|
"resolved": "github:NixOS/nixpkgs/02032da4af073d0f6110540c8677f16d4be0117f?lastModified=1741037377&narHash=sha256-SvtvVKHaUX4Owb%2BPasySwZsoc5VUeTf1px34BByiOxw%3D"
|
||||||
|
},
|
||||||
"nodejs@22": {
|
"nodejs@22": {
|
||||||
"last_modified": "2024-11-16T04:25:12Z",
|
"last_modified": "2024-11-16T04:25:12Z",
|
||||||
"plugin_version": "0.0.2",
|
"plugin_version": "0.0.2",
|
||||||
|
|
|
||||||
75
mkdocs.yaml
75
mkdocs.yaml
|
|
@ -1,81 +1,6 @@
|
||||||
site_name: EDPDoc
|
site_name: EDPDoc
|
||||||
site_description: 'EDP documentation'
|
site_description: 'EDP documentation'
|
||||||
|
|
||||||
nav:
|
|
||||||
- Home: index.md
|
|
||||||
- Contents: contents.md
|
|
||||||
- User Documentation:
|
|
||||||
- ArgoCD: user-documentation/argocd.md
|
|
||||||
- Backstage: user-documentation/backstage.md
|
|
||||||
- CI Workflow: user-documentation/ci-workflow.md
|
|
||||||
- Crossplane: user-documentation/crossplane.md
|
|
||||||
- edpbuilder: user-documentation/edpbuilder.md
|
|
||||||
- Forgejo: user-documentation/forgejo.md
|
|
||||||
- Grafana: user-documentation/grafana.md
|
|
||||||
- Keycloak: user-documentation/keycloak.md
|
|
||||||
- OpenBAO: user-documentation/openbao.md
|
|
||||||
- PetClinic: user-documentation/petclinic.md
|
|
||||||
- Technical Documentation:
|
|
||||||
- Concepts:
|
|
||||||
# - Code: technical-documentation/concepts/1_software-and-workloads/_index.md
|
|
||||||
# - Engineers: technical-documentation/concepts/2_engineering-people/_index.md
|
|
||||||
- Use Cases: technical-documentation/concepts/3_use-cases/_index.md
|
|
||||||
- Platforms:
|
|
||||||
- Platform Engineering: technical-documentation/concepts/4_digital-platforms/platform-engineering/_index.md
|
|
||||||
- Reference Architecture: technical-documentation/concepts/4_digital-platforms/platform-engineering/reference-architecture/_index.md
|
|
||||||
- Platform Components:
|
|
||||||
- CI/CD Pipeline: technical-documentation/concepts/4_digital-platforms/platform-components/cicd-pipeline/_index.md
|
|
||||||
- Developer Portals: technical-documentation/concepts/4_digital-platforms/platform-components/developer-portals/_index.md
|
|
||||||
- Orchestrator: technical-documentation/concepts/4_digital-platforms/platform-components/orchestrator/_index.md
|
|
||||||
- References: technical-documentation/concepts/4_digital-platforms/platform-components/references/_index.md
|
|
||||||
- Orchestrators:
|
|
||||||
- CNOE: technical-documentation/concepts/5_platforms/CNOE/_index.md
|
|
||||||
# - Humanitec: technical-documentation/concepts/5_platforms/Humanitec/_index.md
|
|
||||||
- Solution:
|
|
||||||
- Design:
|
|
||||||
- Architecture:
|
|
||||||
- HighLevelArch: technical-documentation/solution/design/architecture/highlevelarch.md
|
|
||||||
- Decisions:
|
|
||||||
- no1: technical-documentation/solution/design/_index.md
|
|
||||||
# - Scenarios: technical-documentation/solution/scenarios/_index.md
|
|
||||||
- Tools:
|
|
||||||
- Backstage:
|
|
||||||
- Description: technical-documentation/solution/tools/Backstage/general-information/_index.md
|
|
||||||
- Setup Tutorial: technical-documentation/solution/tools/Backstage/backstage-setup-tutorial/_index.md
|
|
||||||
- Existing Plugins: technical-documentation/solution/tools/Backstage/existing-plugins/_index.md
|
|
||||||
- Plugin Creation Tutorial: technical-documentation/solution/tools/Backstage/plugin-creation-tutorial/_index.md
|
|
||||||
- Template Creation Tutorial: technical-documentation/solution/tools/Backstage/template-creation/_index.md
|
|
||||||
- CNOE:
|
|
||||||
- Competitors: technical-documentation/solution/tools/CNOE/competitors/_index.md
|
|
||||||
- Included Backstage Templates:
|
|
||||||
- Basic Argo Workflow: technical-documentation/solution/tools/CNOE/included-backstage-templates/basic-argo-workflow/_index.md
|
|
||||||
- Basic Kubernetes deployment: technical-documentation/solution/tools/CNOE/included-backstage-templates/basic-kubernetes-deployment/_index.md
|
|
||||||
- Idpbuilder:
|
|
||||||
- Installation: technical-documentation/solution/tools/CNOE/idpbuilder/installation/_index.md
|
|
||||||
- Http Routing: technical-documentation/solution/tools/CNOE/idpbuilder/http-routing.md
|
|
||||||
- ArgoCD: technical-documentation/solution/tools/CNOE/argocd/_index.md
|
|
||||||
- Validation and Verification: technical-documentation/solution/tools/CNOE/verification.md
|
|
||||||
- Crossplane:
|
|
||||||
- Provider Kind: technical-documentation/solution/tools/crossplane/provider-kind/_index.md
|
|
||||||
- Kube-Prometheus-Stack: technical-documentation/solution/tools/Kube-prometheus-stack/_index.md
|
|
||||||
- Kyverno Integration: technical-documentation/solution/tools/kyverno-integration/_index.md
|
|
||||||
- Loki: technical-documentation/solution/tools/Loki/_index.md
|
|
||||||
- Promtail: technical-documentation/solution/tools/Promtail/_index.md
|
|
||||||
- Project:
|
|
||||||
- Conceptual Onboarding:
|
|
||||||
- Introduction: technical-documentation/project/conceptual-onboarding/1_intro/_index.md
|
|
||||||
- Edge Developer Framework: technical-documentation/project/conceptual-onboarding/2_edge-developer-framework/_index.md
|
|
||||||
- Platforming: technical-documentation/project/conceptual-onboarding/3_platforming/_index.md
|
|
||||||
- Orchestrators: technical-documentation/project/conceptual-onboarding/4_orchestrators/_index.md
|
|
||||||
- CNOE: technical-documentation/project/conceptual-onboarding/5_cnoe/_index.md
|
|
||||||
- CNOE Showtime: technical-documentation/project/conceptual-onboarding/6_cnoe-showtime/_index.md
|
|
||||||
- Conclusio: technical-documentation/project/conceptual-onboarding/7_conclusio/_index.md
|
|
||||||
- Bootstrapping:
|
|
||||||
- Infrastructure: technical-documentation/project/bootstrapping/_index.md
|
|
||||||
- Backup: technical-documentation/project/bootstrapping/backup/_index.md
|
|
||||||
- Plan 2024: technical-documentation/project/plan-in-2024/_index.md
|
|
||||||
- Stakeholer Workshop: technical-documentation/project/intro-stakeholder-workshop/_index.md
|
|
||||||
- Team Process: technical-documentation/project/team-process/_index.md
|
|
||||||
|
|
||||||
|
|
||||||
plugins:
|
plugins:
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue