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

Rendering for Director Operator docs variant #753

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

jistr
Copy link
Contributor

@jistr jistr commented Dec 3, 2024

No description provided.

@@ -149,6 +149,11 @@ ifeval::["{build}" == "downstream"]
:telemetry: Telemetry service
endif::[]

ifeval::["{build}-{build_variant}" == "downstream-ospdo"]
:OpenStackPreviousInstaller: director_operator
Copy link
Contributor Author

Choose a reason for hiding this comment

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

We need this so that the ifevals from Pini's patches that say

ifeval::["{OpenStackPreviousInstaller}" == "director_operator"]

take effect. However, the OpenStackPreviousInstaller variable is not just used for the conditional, but also in the text. So it actually renders the "director_operator" value into the docs in several places like that, including the underscore.

We should probably replace all the

ifeval::["{OpenStackPreviousInstaller}" == "director_operator"]

with

ifeval::["{build_variant}" == "ospdo"]

and then set the OpenStackPreviousInstaller variable to something that looks nice in the rendered docs? @klgill @pinikomarov

Copy link
Contributor

Choose a reason for hiding this comment

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

Yeah, OpenStackPreviousInstaller = director in the rendered downstream docs, and "TripleO" in the upstream rendered docs. This was done because downstream and upstream refer to the installer differently.

TBH I'm not sure why OpenStackPreviousInstaller was being used for the ifeval statement for OSPdO docs. Does the OSPdO content need its own value for the OpenStackPreviousInstaller variable in the text itself? Currently, we've just written the terms "director Operator" and "OSPdO" as is because the content is conditionalized for OSPdO anyway. I could be misunderstanding though.

Copy link
Contributor

Choose a reason for hiding this comment

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

I used OpenStackPreviousInstaller as a method to differentiate ospdo from regular director , that method could be any thing actually , as long as it preserves the logic

Copy link

Build failed (check pipeline). Post recheck (without leading slash)
to rerun all jobs. Make sure the failure cause has been resolved before
you rerun jobs.

https://softwarefactory-project.io/zuul/t/rdoproject.org/buildset/991072895ebe4d53a4b1b931ae3dd45e

✔️ noop SUCCESS in 0s
✔️ adoption-standalone-to-crc-ceph SUCCESS in 3h 18m 27s
✔️ adoption-standalone-to-crc-no-ceph SUCCESS in 3h 17m 08s
adoption-docs-preview FAILURE in 1m 13s

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.

3 participants