Skip to content

WIP/EXPERIMENT: CI for guides#3553

Draft
snazy wants to merge 2 commits intoapache:mainfrom
snazy:guides-ci
Draft

WIP/EXPERIMENT: CI for guides#3553
snazy wants to merge 2 commits intoapache:mainfrom
snazy:guides-ci

Conversation

@snazy
Copy link
Member

@snazy snazy commented Jan 26, 2026

No description provided.

@github-project-automation github-project-automation bot moved this to PRs In Progress in Basic Kanban Board Jan 26, 2026
@snazy snazy force-pushed the guides-ci branch 20 times, most recently from a89d496 to 21f7718 Compare January 27, 2026 22:14
@snazy snazy mentioned this pull request Jan 27, 2026
6 tasks
@snazy snazy force-pushed the guides-ci branch 7 times, most recently from d89a242 to fdc26b8 Compare January 28, 2026 13:34
@snazy snazy force-pushed the guides-ci branch 3 times, most recently from c244659 to 72809b6 Compare January 29, 2026 14:01
snazy added a commit to snazy/polaris that referenced this pull request Jan 29, 2026
The statements in the shell scripts for the setup services are often concatenated using `;`, which means that a previous' command exit code is _not_ propagated and the service, although it failed, is determined to be successful.

This change updates those scripts to use `&&` for the statement concatenation.

"Final" setup services (aka "polaris-setup") now have a final `sleep 120`. This is due to the behavior of `docker compose up --detach --wait`, which considers _any_ service (without dependants) that exits with exit code 0 as a failure, leading to that docker-compose command yielding an error code. That would break the guides testing code (apache#3553).

To avoid merge conflicts, this change also:
* updates affected `curl` invocations (as apache#3610)
* removes superfluous `restart: "no"`
snazy added a commit to snazy/polaris that referenced this pull request Jan 29, 2026
The statements in the shell scripts for the setup services are often concatenated using `;`, which means that a previous' command exit code is _not_ propagated and the service, although it failed, is determined to be successful.

This change updates those scripts to use `&&` for the statement concatenation.

"Final" setup services (aka "polaris-setup") now have a final `sleep 120`. This is due to the behavior of `docker compose up --detach --wait`, which considers _any_ service (without dependants) that exits with exit code 0 as a failure, leading to that docker-compose command yielding an error code. That would break the guides testing code (apache#3553). That `sleep 120` in "polaris-setup" services does **not** cause a delay of the compose starting up - it is purely a "hack around" Docker Compose not having a notion of "setup services".

To avoid merge conflicts, this change also:
* updates affected `curl` invocations (as apache#3610)
* removes superfluous `restart: "no"`
snazy added a commit to snazy/polaris that referenced this pull request Jan 29, 2026
The statements in the shell scripts for the setup services are often concatenated using `;`, which means that a previous' command exit code is _not_ propagated and the service, although it failed, is determined to be successful.

This change updates those scripts to use `&&` for the statement concatenation.

"Final" setup services (aka "polaris-setup") now have a final `sleep 120`. This is due to the behavior of `docker compose up --detach --wait`, which considers _any_ service (without dependants) that exits with exit code 0 as a failure, leading to that docker-compose command yielding an error code. That would break the guides testing code (apache#3553). That `sleep 120` in "polaris-setup" services does **not** cause a delay of the compose starting up - it is purely a "hack around" Docker Compose not having a notion of "setup services".

To avoid merge conflicts, this change also:
* updates affected `curl` invocations (as apache#3610)
* removes superfluous `restart: "no"`
snazy added a commit to snazy/polaris that referenced this pull request Jan 29, 2026
The statements in the shell scripts for the setup services are often concatenated using `;`, which means that a previous' command exit code is _not_ propagated and the service, although it failed, is determined to be successful.

This change updates those scripts to use `&&` for the statement concatenation.

"Final" setup services (aka "polaris-setup") now have a final `sleep 120`. This is due to the behavior of `docker compose up --detach --wait`, which considers _any_ service (without dependants) that exits with exit code 0 as a failure, leading to that docker-compose command yielding an error code. That would break the guides testing code (apache#3553). That `sleep 120` in "polaris-setup" services does **not** cause a delay of the compose starting up - it is purely a "hack around" Docker Compose not having a notion of "setup services".

To avoid merge conflicts, this change also:
* updates affected `curl` invocations (as apache#3610)
* removes superfluous `restart: "no"`
snazy added a commit to snazy/polaris that referenced this pull request Jan 29, 2026
The statements in the shell scripts for the setup services are often concatenated using `;`, which means that a previous' command exit code is _not_ propagated and the service, although it failed, is determined to be successful.

This change updates those scripts to use `&&` for the statement concatenation.

"Final" setup services (aka "polaris-setup") now have a final `sleep 120`. This is due to the behavior of `docker compose up --detach --wait`, which considers _any_ service (without dependants) that exits with exit code 0 as a failure, leading to that docker-compose command yielding an error code. That would break the guides testing code (apache#3553). That `sleep 120` in "polaris-setup" services does **not** cause a delay of the compose starting up - it is purely a "hack around" Docker Compose not having a notion of "setup services".

To avoid merge conflicts, this change also:
* updates affected `curl` invocations (as apache#3610)
* removes superfluous `restart: "no"`
snazy added a commit to snazy/polaris that referenced this pull request Jan 30, 2026
The statements in the shell scripts for the setup services are often concatenated using `;`, which means that a previous' command exit code is _not_ propagated and the service, although it failed, is determined to be successful.

This change updates those scripts to use `&&` for the statement concatenation.

"Final" setup services (aka "polaris-setup") now have a final `sleep 120`. This is due to the behavior of `docker compose up --detach --wait`, which considers _any_ service (without dependants) that exits with exit code 0 as a failure, leading to that docker-compose command yielding an error code. That would break the guides testing code (apache#3553). That `sleep 120` in "polaris-setup" services does **not** cause a delay of the compose starting up - it is purely a "hack around" Docker Compose not having a notion of "setup services".

To avoid merge conflicts, this change also:
* updates affected `curl` invocations (as apache#3610)
* removes superfluous `restart: "no"`
snazy added a commit to snazy/polaris that referenced this pull request Jan 31, 2026
The statements in the shell scripts for the setup services are often concatenated using `;`, which means that a previous' command exit code is _not_ propagated and the service, although it failed, is determined to be successful.

This change updates those scripts to use `&&` for the statement concatenation.

"Final" setup services (aka "polaris-setup") now have a final `sleep 120`. This is due to the behavior of `docker compose up --detach --wait`, which considers _any_ service (without dependants) that exits with exit code 0 as a failure, leading to that docker-compose command yielding an error code. That would break the guides testing code (apache#3553). That `sleep 120` in "polaris-setup" services does **not** cause a delay of the compose starting up - it is purely a "hack around" Docker Compose not having a notion of "setup services".

To avoid merge conflicts, this change also:
* updates affected `curl` invocations (as apache#3610)
* removes superfluous `restart: "no"`
snazy added a commit to snazy/polaris that referenced this pull request Jan 31, 2026
The statements in the shell scripts for the setup services are often concatenated using `;`, which means that a previous' command exit code is _not_ propagated and the service, although it failed, is determined to be successful.

This change updates those scripts to use `&&` for the statement concatenation.

"Final" setup services (aka "polaris-setup") now have a final `sleep 120`. This is due to the behavior of `docker compose up --detach --wait`, which considers _any_ service (without dependants) that exits with exit code 0 as a failure, leading to that docker-compose command yielding an error code. That would break the guides testing code (apache#3553). That `sleep 120` in "polaris-setup" services does **not** cause a delay of the compose starting up - it is purely a "hack around" Docker Compose not having a notion of "setup services".

To avoid merge conflicts, this change also:
* updates affected `curl` invocations (as apache#3610)
* removes superfluous `restart: "no"`
@snazy snazy force-pushed the guides-ci branch 3 times, most recently from 8e9d08b to 2c4b065 Compare February 2, 2026 12:15
snazy added a commit to snazy/polaris that referenced this pull request Feb 2, 2026
The statements in the shell scripts for the setup services are often concatenated using `;`, which means that a previous' command exit code is _not_ propagated and the service, although it failed, is determined to be successful.

This change updates those scripts to use `&&` for the statement concatenation.

"Final" setup services (aka "polaris-setup") now have a final `sleep 120`. This is due to the behavior of `docker compose up --detach --wait`, which considers _any_ service (without dependants) that exits with exit code 0 as a failure, leading to that docker-compose command yielding an error code. That would break the guides testing code (apache#3553). That `sleep 120` in "polaris-setup" services does **not** cause a delay of the compose starting up - it is purely a "hack around" Docker Compose not having a notion of "setup services".

To avoid merge conflicts, this change also:
* updates affected `curl` invocations (as apache#3610)
* removes superfluous `restart: "no"`
snazy added a commit to snazy/polaris that referenced this pull request Feb 2, 2026
The statements in the shell scripts for the setup services are often concatenated using `;`, which means that a previous' command exit code is _not_ propagated and the service, although it failed, is determined to be successful.

This change updates those scripts to use `&&` for the statement concatenation.

"Final" setup services (aka "polaris-setup") now have a final `sleep 120`. This is due to the behavior of `docker compose up --detach --wait`, which considers _any_ service (without dependants) that exits with exit code 0 as a failure, leading to that docker-compose command yielding an error code. That would break the guides testing code (apache#3553). That `sleep 120` in "polaris-setup" services does **not** cause a delay of the compose starting up - it is purely a "hack around" Docker Compose not having a notion of "setup services".

To avoid merge conflicts, this change also:
* updates affected `curl` invocations (as apache#3610)
* removes superfluous `restart: "no"`
@snazy snazy added the documentation Improvements or additions to documentation, especially web site content label Feb 2, 2026
snazy added a commit that referenced this pull request Feb 3, 2026
The statements in the shell scripts for the setup services are often concatenated using `;`, which means that a previous' command exit code is _not_ propagated and the service, although it failed, is determined to be successful.

This change updates those scripts to use `&&` for the statement concatenation.

"Final" setup services (aka "polaris-setup") now have a final `sleep 120`. This is due to the behavior of `docker compose up --detach --wait`, which considers _any_ service (without dependants) that exits with exit code 0 as a failure, leading to that docker-compose command yielding an error code. That would break the guides testing code (#3553). That `sleep 120` in "polaris-setup" services does **not** cause a delay of the compose starting up - it is purely a "hack around" Docker Compose not having a notion of "setup services".

To avoid merge conflicts, this change also:
* updates affected `curl` invocations (as #3610)
* removes superfluous `restart: "no"`
@snazy snazy force-pushed the guides-ci branch 2 times, most recently from 6159cd4 to 6716d92 Compare February 4, 2026 07:32
snazy added 2 commits February 4, 2026 10:14
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
sungwy pushed a commit to sungwy/polaris that referenced this pull request Feb 7, 2026
The statements in the shell scripts for the setup services are often concatenated using `;`, which means that a previous' command exit code is _not_ propagated and the service, although it failed, is determined to be successful.

This change updates those scripts to use `&&` for the statement concatenation.

"Final" setup services (aka "polaris-setup") now have a final `sleep 120`. This is due to the behavior of `docker compose up --detach --wait`, which considers _any_ service (without dependants) that exits with exit code 0 as a failure, leading to that docker-compose command yielding an error code. That would break the guides testing code (apache#3553). That `sleep 120` in "polaris-setup" services does **not** cause a delay of the compose starting up - it is purely a "hack around" Docker Compose not having a notion of "setup services".

To avoid merge conflicts, this change also:
* updates affected `curl` invocations (as apache#3610)
* removes superfluous `restart: "no"`
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation, especially web site content

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant