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

[discourse-gatekeeper] Migrate charm docs #44

Merged
merged 5 commits into from
Feb 1, 2024
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
2 changes: 1 addition & 1 deletion docs/how-to/contribute.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,4 +84,4 @@ juju deploy ./jenkins-agent-k8s_ubuntu-22.04-amd64.charm \

## Canonical Contributor Agreement

Canonical welcomes contributions to the Jenkins agent k8s operator. Please check out our [contributor agreement](https://ubuntu.com/legal/contributors) if you're interested in contributing to the solution.
Canonical welcomes contributions to the Jenkins agent k8s operator. Please check out our [contributor agreement](https://ubuntu.com/legal/contributors) if you're interested in contributing to the solution.
14 changes: 12 additions & 2 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,5 +19,15 @@ If there's a particular area of documentation that you'd like to see that's miss
| [Tutorials](https://charmhub.io/jenkins-agent-k8s/docs/tutorial-getting-started)</br> Get started - a hands-on introduction to using the Charmed Indico operator for new users </br> | [How-to guides](https://charmhub.io/jenkins-agent-k8s/docs/how-to-contribute) </br> Step-by-step guides covering key operations and common tasks |
| [Reference](https://charmhub.io/jenkins-agent-k8s/docs/reference-actions) </br> Technical information - specifications, APIs, architecture | [Explanation](https://charmhub.io/jenkins-agent-k8s/docs/explanation-charm-architecture) </br> Concepts - discussion and clarification of key topics |

# Navigation

# Contents

1. [Explanation](explanation)
1. [Charm architecture](explanation/charm-architecture.md)
1. [How To](how-to)
1. [How to contribute](how-to/contribute.md)
1. [Reference](reference)
1. [Actions](reference/actions.md)
1. [Configurations](reference/configurations.md)
1. [Integrations](reference/integrations.md)
1. [Tutorial](tutorial)
1. [Quick guide](tutorial/getting-started.md)
2 changes: 1 addition & 1 deletion docs/reference/actions.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Actions

See [Actions](https://charmhub.io/jenkins-agent-k8s/actions).
See [Actions](https://charmhub.io/jenkins-agent-k8s/actions).
2 changes: 1 addition & 1 deletion docs/reference/configurations.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Configurations

See [Configure](https://charmhub.io/jenkins-agent-k8s/configure).
See [Configure](https://charmhub.io/jenkins-agent-k8s/configure).
2 changes: 1 addition & 1 deletion docs/reference/integrations.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,4 @@ _Supported charms_: [jenkins](https://charmhub.io/jenkins)

Agent integration is a required relation for the Jenkins agent charm to supply the job execution output to Jenkins.

Example agent integrate command: `juju integrate jenkins jenkins-agent-k8s`
Example agent integrate command: `juju integrate jenkins jenkins-agent-k8s`
2 changes: 1 addition & 1 deletion docs/tutorial/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,4 +59,4 @@ jenkins-agent-k8s active 1 jenkins-agent-k8s stable 18 10.

```

The deployment finishes when the status shows "Active".
The deployment finishes when the status shows "Active".
Loading