Skip to content

Commit

Permalink
Sync with main (#888)
Browse files Browse the repository at this point in the history
* draft: docs for kubefirst local (#823)

* removing duplicate port forward to minio

* fix kubefirst local connect output

* removing nginx loadbalancer during destroy

* removing old lb/sg removal process

* adjusting gitops nginx removal to fresh clone

* remove branch mgmt from private clone

* latest round of orchestration

* local docs starting point

* adding kubefirst local docs

* Update docs/index.md

Co-authored-by: Jared Edwards <jared@kubefirst.com>

Co-authored-by: Jared Edwards <jared@kubefirst.com>

* orchestrating ingress-nginx removal (#860)

* Update index.md (#862)

* create an issue template form for the documentations

Signed-off-by: Frédéric Harper <hi@fred.dev>

* fix the documentation test & publication process (#806)

Signed-off-by: Frédéric Harper <hi@fred.dev>
Co-authored-by: John Dietz <john@kubefirst.com>
Co-authored-by: Jared Edwards <jared@kubefirst.com>
Co-authored-by: Frédéric Harper <hi@fred.dev>
Co-authored-by: Frédéric Harper <fred@kubeshop.io>
  • Loading branch information
5 people authored Dec 13, 2022
1 parent 16fb64c commit 2e7a64b
Show file tree
Hide file tree
Showing 2 changed files with 48 additions and 6 deletions.
42 changes: 42 additions & 0 deletions .github/ISSUE_TEMPLATE/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
name: Documentations
description: Any suggestions related to the documentation, whether it's an issue, missing information, unclear steps or new page that should be created
title: "[Docs]: "
labels: ["docs"]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out a documentation issue! If you need help, please ask your question in our [Slack community](http://kubefirst.io/slack).
- type: dropdown
id: type
attributes:
label: What type of suggestions?
multiple: false
options:
- Missing Information
- Wrong Information
- Unclear Documentation
validations:
required: true
- type: input
id: page
attributes:
label: What page is concerned?
description: If needed, URL to the page with missing or unclear information
placeholder: https://docs.kubefirst.io/
- type: textarea
id: issue
attributes:
label: What is the issue?
description: Give us as many details as possible about the issue with the documentation
placeholder: Tell us what can be improved!
validations:
required: true
- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/kubefirst/kubefirst/blob/main/CODE_OF_CONDUCT.md)
options:
- label: I agree to follow this project's Code of Conduct
required: true
12 changes: 6 additions & 6 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
# mkdocs

### running docs on your localhost
## running docs on your localhost

1. start the mkdocs-material container from your repo root directory:
```

```shell
# run the following from the repo root
docker run --rm -it -p 8000:8000 -v ${PWD}:/docs squidfunk/mkdocs-material
```
2. click http://localhost:8000
3. edit your markdown documentation in your favorite editor and get realtime feedback

### publishing to preprod (temp docs)
2. click <http://localhost:8000>
3. edit your Markdown documentation in your favorite editor and get realtime feedback

merging docs changes to the main branch will automatically kick off a publish to preprod using the [Publish Docs](https://github.com/kubefirst/kubefirst/actions/workflows/publish-docs.yaml) action.
[https://docs.kubefirst.com/preprod/index.html](https://docs.kubefirst.com/preprod/index.html)
Expand All @@ -19,4 +19,4 @@ merging docs changes to the main branch will automatically kick off a publish to
### promote to prod

after confirming there are no rendering issues in preprod, run the github action [Promote Docs To Prod](https://github.com/kubefirst/kubefirst/actions/workflows/promote-docs-to-prod.yaml) to update the live site.
[https://docs.kubefirst.com/index.html](https://docs.kubefirst.com/index.html)
[https://docs.kubefirst.com/index.html](https://docs.kubefirst.com/index.html)

0 comments on commit 2e7a64b

Please sign in to comment.