[Site] Add getting-started guides as "Guides" to the web site#3550
Open
snazy wants to merge 1 commit intoapache:mainfrom
Open
[Site] Add getting-started guides as "Guides" to the web site#3550snazy wants to merge 1 commit intoapache:mainfrom
snazy wants to merge 1 commit intoapache:mainfrom
Conversation
snazy
force-pushed
the
guides-on-site
branch
4 times, most recently
from
2b3a442 to
1aba13e
Compare
snazy
added
the
documentation
This change follows up on the [dev-mailing list discussion](https://lists.apache.org/thread/gwxn34nzvhdqdjw2bst6kwlqt8jhb91d) and adds the guides under `getting-started/` to the web site as "Guides". * The guides had to me moved from the `getting-started/` folder into the `site/content/` folder structure, because symlinks from the `site/content/` _folder_ do not work (the contents are not pulled in). * Each guide's `README.md` file has been renamed to `index.md`, added a front-matter, which instructs Hugo to that also lets Hugo include the guide in the top-level menu. * Assets for each guide are listed at the top of each guide, so users do not have to go via GitHub. * Links in the guides have been updated. * A new layout named `guides` has been added for this use case. Two changes on the Ceph guide: * updated the misplaced `yaml` type on a code snippet * renamed `.env.example` to `dot-env.example`, because files starting with a `.` are not included
dimas-b
reviewed
Feb 5, 2026
Contributor
dimas-b
left a comment
dimas-b
left a comment
There was a problem hiding this comment.
Good idea to host guides on the site 👍
|
|
||
| ```shell | ||
| docker compose -f getting-started/minio/docker-compose.yml up | ||
| docker compose -f site/content/guides/minio/docker-compose.yml up |
Contributor
There was a problem hiding this comment.
Is it worth having "assets" downloadable from the site, when this command assumes running in a local source repo clone?
For example, the docker-compose script refers to ../assets/polaris 🤔
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This change follows up on the dev-mailing list discussion and adds the guides under
getting-started/to the web site as "Guides".getting-started/folder into thesite/content/folder structure, because symlinks from thesite/content/folder do not work (the contents are not pulled in).README.mdfile has been renamed toindex.md, added a front-matter, which instructs Hugo to that also lets Hugo include the guide in the top-level menu.guideshas been added for this use case.Two changes on the Ceph guide:
yamltype on a code snippet.env.exampletodot-env.example, because files starting with a.are not included