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.

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

docs: docs structure improvement #584

Merged
merged 1 commit into from
May 23, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@

## Plugins needed

1. [github-repo-scaffolding-golang](/docs/plugins/github-repo-scaffolding-golang)
2. [jira-github](/docs/plugins/jira-github-integ)
3. [githubactions-golang](/docs/plugins/githubactions-golang)
4. [argocd](/docs/plugins/argocd)
5. [argocdapp](/docs/plugins/argocdapp)
1. [github-repo-scaffolding-golang](../plugins/github-repo-scaffolding-golang)
2. [jira-github](../plugins/jira-github-integ)
3. [githubactions-golang](../plugins/githubactions-golang)
4. [argocd](../plugins/argocd)
5. [argocdapp](../plugins/argocdapp)

The dependencies of these plugins are(`a -> b` means for `a depends on b`):

Expand All @@ -28,7 +28,7 @@ Download the appropriate `dtm` version for your platform from [DevStream Release

## Prepare the Config File

Copy the [gitops.yaml](../../../examples/gitops.yaml), [tools-gitops.yaml](../../../examples/tools-gitops.yaml) and [variables-gitops.yaml](../../../examples/variables-gitops.yaml) to your working directory:
Download the `gitops.yaml`, `tools-gitops.yaml` and `variables-gitops.yaml` to your working directory:

```bash
curl -o config-gitops.yaml https://raw.githubusercontent.com/devstream-io/devstream/main/examples/gitops.yaml
Expand Down
File renamed without changes
File renamed without changes
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,4 @@ TL;DR: DevStream (CLI tool named `dtm`) is an open-source DevOps toolchain manag
## Get Started

- [Quick Start](quickstart_en.md)
- [Best Pratices - GitOps Toolchain](tutorials/best-practices/gitops.md)
- [Best Pratices - GitOps Toolchain](best-practices/gitops.md)
2 changes: 1 addition & 1 deletion docs/plugins/argocdapp.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ This plugin creates an [ArgoCD Application](https://argo-cd.readthedocs.io/en/st
- ArgoCD itself must have been already installed before the usage of this plugin.
To install ArgoCD, use the [argocd plugin](argocd).
Or you can use both plugins(argocd+argocdapp) at the same time.
See [GitOps Toolchain](/docs/tutorials/best-practices/gitops) for more info.
See [GitOps Toolchain](/docs/best-practices/gitops) for more info.
- Currently, only the Helm chart is supported when creating the ArgoCD application.
- Modify the file accordingly. Especially remember to modify `ARGOCD_TOOL_NAME`.

Expand Down
6 changes: 6 additions & 0 deletions docs/versions.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"latest": "latest",
"versions": {
"v0.6.0": "https://docs.devstream.io/en/v0.6.0/"
}
}
12 changes: 8 additions & 4 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,17 @@ site_description: The DevStream Docs
markdown_extensions:
toc:
permalink: true
extra:
version:
provider: json
index: "https://docs.devstream.io/en/latest/"
current: latest
nav:
- 'quickstart_en.md'
- Tutorials:
- 'tutorials/autocomplete.md'
- Best Pratices:
- 'tutorials/best-practices/gitops.md'
- Best Practices:
- 'best-practices/gitops.md'
- Commands:
- 'commands/autocomplete.md'
- 'commands/init.md'
- 'commands/apply.md'
- 'commands/verify.md'
Expand Down