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.

Sign up for GitHub

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

Jump to bottom

docs: update list of primary doc folders/titles #2445

Merged
merged 4 commits into from
Nov 8, 2023
Merged

docs: update list of primary doc folders/titles #2445

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
4220cdc
docs: update list of primary doc folders/titles
StackScribe Nov 8, 2023
c4d160c
Update docs/content/en/contribute/docs/source-file-structure/_index.md
StackScribe Nov 8, 2023
9168ab6
Update docs/content/en/contribute/docs/source-file-structure/_index.md
StackScribe Nov 8, 2023
afd2ccd
Update docs/content/en/contribute/docs/source-file-structure/_index.md
StackScribe Nov 8, 2023
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
21 changes: 18 additions & 3 deletions docs/content/en/contribute/docs/source-file-structure/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,14 +33,23 @@ In the order they appear in the rendered docs, the subdirectories are:
Requirements and instructions for installing and enabling Keptn
* **operate** (Operate Keptn):
Guides about running and managing the Keptn cluster
* **implementing** (Implementing Keptn applications):
* **implementing** (User Guides):
This is currently a catch-all section
for guides and how-to material about implementing Keptn features.
It needs to be restructured and subdivided
* **troubleshooting.md** (Troubleshooting Guide):
How to diagnose and solve common problems with Keptn
* **architecture** (Architecture):
Information about how Keptn actually works

* **components** (Keptn Components)

* **lifecycle-operator** (Keptn Lifecycle Operator)
* **metrics-operator** (Keptn Metrics Operator)
* **scheduler** (Keptn integration with Scheduling)

* **deployment-flow** (Flow of deployment)
* **keptn-apps** (KeptnApp and KeptnWorkflow)
StackScribe marked this conversation as resolved.
Show resolved Hide resolved
* **cert-manager** (Keptn Certification Manager)
StackScribe marked this conversation as resolved.
Show resolved Hide resolved

* **crd-ref** (API Reference):
Comprehensive information about all the APIs that define the Keptn CRDs.
This section is auto-generated from source code
Expand Down Expand Up @@ -88,6 +97,12 @@ leaving links to the various sections in the *CONTRIBUTING.md* guides.

## Build strategy

This section discusses how the individual files and directories
are assembled into the documenation set.
StackScribe marked this conversation as resolved.
Show resolved Hide resolved
See
[Published Doc Structure](../publish)
for information about the branches where the documentation is published.

All files in the directories are built
except for files that are explicitly `ignored`
and files that include the `hidden: true` string in the file's metadata section.
Expand Down