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.

Sign up for GitHub

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

Jump to bottom

Add a way to EOL package docs separate from core docs #1490

Open
samccann opened this issue May 20, 2024 · 1 comment · May be fixed by #1695
Open

Add a way to EOL package docs separate from core docs #1490

samccann opened this issue May 20, 2024 · 1 comment · May be fixed by #1695
Labels
doc builds Relates to building the documentation

Comments

@samccann
Copy link
Contributor

My and my simple mind forgot the eol flag logic in the conf.py will actually trigger eol banner and remove the version switcher for both core and package docs.

(see #1489 for reverting a mistake like this)

That PR also has a suggestion on how to change the logic so it detects and seaprately EOL's -

  • core and lang docs (they are on the same schedule)
  • package docs (on a different schedule and EOL much sooner than the underlying core version).
@ansible-documentation-bot ansible-documentation-bot bot added the needs_triage Needs a first human triage before being processed. label May 20, 2024
@samccann samccann added doc builds Relates to building the documentation and removed needs_triage Needs a first human triage before being processed. labels May 21, 2024
@samccann samccann linked a pull request Jul 15, 2024 that will close this issue
Draft
@oraNod
Copy link
Contributor

oraNod commented Dec 2, 2024

Summarizing some conversation from #1695

At the moment there's a boolean flag in the Sphinx conf.py file that determines if the docs are EOL or not:

ansible-documentation/docs/docsite/rst/conf.py

Line 230 in 186f2d7

'is_eol': False,

This causes both package and core docs to use the EOL banner at the same time, instead of on separate schedules. A possible solution is to have an external declarative configuration file as mentioned here: #1695 (comment)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
doc builds Relates to building the documentation
Projects
Ansible Documentation
Status: 🆕 Triage
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

add option to eol just the package docs samccann/ansible-documentation
2 participants
@samccann @oraNod