https://github.com/cloud-design-patterns-journey/docs

Static documentation site for Cloud Deisgn Patterns learning journey.
https://github.com/cloud-design-patterns-journey/docs

cloud cloud-design-pattern documentation hands-on hybrid-cloud kubernetes learning mkdocs mkdocs-material mkdocs-site openshift

Last synced: 17 days ago
JSON representation

Static documentation site for Cloud Deisgn Patterns learning journey.

• Host: GitHub
• URL: https://github.com/cloud-design-patterns-journey/docs
• Owner: cloud-design-patterns-journey
• License: mit
• Created: 2024-04-15T13:21:49.000Z (7 months ago)
• Default Branch: main
• Last Pushed: 2024-04-29T10:03:33.000Z (7 months ago)
• Last Synced: 2024-10-16T13:09:00.521Z (about 1 month ago)
• Topics: cloud, cloud-design-pattern, documentation, hands-on, hybrid-cloud, kubernetes, learning, mkdocs, mkdocs-material, mkdocs-site, openshift
• Language: HTML
• Homepage: https://cloud-design-patterns-journey.github.io/docs/
• Size: 8.71 MB
• Stars: 1
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Cloud Design Patterns Journey

Static documentation site for Cloud Deisgn Patterns learning journey.

## How to contribute

1. Clone this repository:

    ```sh

    git clone https://github.com/cloud-design-patterns-journey/docs

    cd docs

    ```

2. Create your own branch from `main`:

    ```sh

    export BRANCH_NAME=

    git checkout -b $BRANCH_NAME

    ```

3. Add your doc(s) as `.md` file(s) in the `docs` folder.

4. Update the `nav` section of `mkdocs.yaml` to reference your new docs.

5. Commit and push your changes:

    ```sh

    git add mkdocs.yaml docs

    git commit -s -m ''

    git push -u origin $BRANCH_NAME

    ```

6. Create a [new pull request](https://github.com/cloud-design-patterns-journey/docs/compare) by selecting `base:main` and `compare:$BRANCH_NAME`, then click `Create pull request`.

7. After all checks have passed, click `Merge` then `Delete branch`.

8. *Optional*: After PR is closed, you can clear you local changes:

    ```sh

    git checkout main

    git pull

    git branch -d $BRANCH_NAME

    ```