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

Add MkDocs for k8gb Documentation #1838

Closed
wants to merge 1 commit into from
Closed

Conversation

falconcr
Copy link

MkDocs integration

This PR integrates MkDocs to improve the documentation structure for k8gb. The changes include:

  • Adding mkdocs.yml with initial configuration.
  • Setting up a basic folder structure for documentation.
  • Adding instructions on how to serve the documentation locally.

Demo

https://youtu.be/8eROmJg71gw

Copy link
Member

@ytsarev ytsarev left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@falconcr thanks a lot for the contribution! Could you please follow DCO https://github.com/k8gb-io/k8gb/pull/1838/checks?check_run_id=37995383525 by signing off the commits?

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Signed-off-by: Gerardo Lopez  <gelopfalcongde@gmail.com>
Add draft version of k8gb webpage

Signed-off-by: Gerardo Lopez  <gelopfalcongde@gmail.com>
update renovate json
Signed-off-by: Gerardo Lopez  <gelopfalcongde@gmail.com>
Adding mkdocs

[create-pull-request] automated change (k8gb-io#1818)

Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: ytsarev <518532+ytsarev@users.noreply.github.com>

Update CODEOWNERS (k8gb-io#1821)

- Only the last matching rule is applied, so separate rules won't work as expected.
- Keep all owners in a single rule for full repository ownership.
- Comments must be placed above or beside the relevant line.

Signed-off-by: Bradley Andersen <bradley.andersen@pm.me>

Adding Darede to the ADOPTERS list (k8gb-io#1824)

Signed-off-by: Diego Marques <diegodmarques7@gmail.com>

chore(deps): update otel/opentelemetry-collector docker tag to v0.119.0 (k8gb-io#1823)

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

fix(deps): update module github.com/gruntwork-io/terratest to v0.48.2 (k8gb-io#1822)

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

[create-pull-request] automated change (k8gb-io#1825)

Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: ytsarev <518532+ytsarev@users.noreply.github.com>

chore(deps): update all non-major dependencies (k8gb-io#1819)

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

[create-pull-request] automated change (k8gb-io#1826)

Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: ytsarev <518532+ytsarev@users.noreply.github.com>

Update Non-goals (k8gb-io#1820)

* Update Non-goals
* Fix consistent project name case over the text

Signed-off-by: Yury Tsarev <yury@upbound.io>

Remove SplitBrain implementation (k8gb-io#1829)

- from CRD
- Terratests
- CR, Spec definition
- HelmChart

Signed-off-by: Michal K <kuritka@gmail.com>

ubuntu-20.04 hosted runner image is closing down: bump to 24.04 (k8gb-io#1836)

Signed-off-by: Jirka Kremser <jiri.kremser@gmail.com>

update makefile

update makefile

update makefile

update makefile

update makefile

remove regex

Merge upstream main into local branch

Merged latest changes from the official k8gb repository main branch to keep the local branch up to date.

Signed-off-by: Gerardo López Falcón <gelopfalcongde@gmail.com>
Copy link

netlify bot commented Mar 5, 2025

Deploy Preview for k8gb-preview ready!

Name Link
🔨 Latest commit 569151a
🔍 Latest deploy log https://app.netlify.com/sites/k8gb-preview/deploys/67c8c179b80e9100080a37ac
😎 Deploy Preview https://deploy-preview-1838--k8gb-preview.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@falconcr falconcr closed this Mar 6, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants