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: 📝 Improve documentation and project structure #25

Merged
merged 42 commits into from
Jul 15, 2024
Merged

Conversation

JamesIves
Copy link
Owner

@JamesIves JamesIves commented Jul 15, 2024

Description

  • Improved project structure
  • Moved everything to a sub container directory.
  • Added README samples in the root docker-compose.yml file.
  • Added container labels based on the opencontainers spec.

JamesIves and others added 30 commits July 5, 2024 12:57
* Update README.md

* Create sponsors.yml

* Create label.yml

* test: resolve issue thing

* style: remove typo

* chore: update
Bumps [softprops/action-gh-release](https://github.com/softprops/action-gh-release) from 1 to 2.
- [Release notes](https://github.com/softprops/action-gh-release/releases)
- [Changelog](https://github.com/softprops/action-gh-release/blob/master/CHANGELOG.md)
- [Commits](softprops/action-gh-release@v1...v2)

---
updated-dependencies:
- dependency-name: softprops/action-gh-release
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Bumps [actions/checkout](https://github.com/actions/checkout) from 3 to 4.
- [Release notes](https://github.com/actions/checkout/releases)
- [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md)
- [Commits](actions/checkout@v3...v4)

---
updated-dependencies:
- dependency-name: actions/checkout
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
* docs: docker whale image

* Update README.md

* Update README.md

* Update README.md

* docs: add more examples

* docs: add more examples

* docs: improve docs

* Update README.md

* Update README.md

* Update README.md

* test

* Update BUILDING_AN_IMAGE.md
@github-actions github-actions bot added build 🔧 Changes that effect how the build system works. documentation 📖 Documentation related changes. feature ✨ This change introduces a new feature. labels Jul 15, 2024
JamesIves and others added 10 commits July 15, 2024 07:31
…24)

Bumps [anothrNick/github-tag-action](https://github.com/anothrnick/github-tag-action) from 1.69.0 to 1.70.0.
- [Release notes](https://github.com/anothrnick/github-tag-action/releases)
- [Commits](anothrNick/github-tag-action@1.69.0...1.70.0)

---
updated-dependencies:
- dependency-name: anothrNick/github-tag-action
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
@JamesIves JamesIves changed the title docs: 📝 Improve documentation again docs: 📝 Improve documentation and project structure Jul 15, 2024
@JamesIves JamesIves merged commit 9929c52 into main Jul 15, 2024
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
build 🔧 Changes that effect how the build system works. documentation 📖 Documentation related changes. feature ✨ This change introduces a new feature.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant