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

Deprecated feature snippet #3620

Closed
wants to merge 1 commit into from

Conversation

apinnick
Copy link
Contributor

@apinnick apinnick commented Jan 28, 2025

What changes are you introducing?

Adding a "Deprecated snippet" for Satellite only.

Why are you introducing these changes? (Explanation, links to references, issues, etc.)

I want to increase the visibility of deprecated features in the documentation.

This snippet is used in other Red Hat documentation repos and aligns with our downstream conventions.

Anything else to add? (Considerations, potential downsides, alternative solutions you have explored, etc.)

No tech review or testing required.

Checklists

  • I am okay with my commits getting squashed when you merge this PR.
  • I am familiar with the contributing guidelines.

Please cherry-pick my commits into:

  • Foreman 3.13/Katello 4.15 (EL9 only)
  • Foreman 3.12/Katello 4.14 (Satellite 6.16)
  • Foreman 3.11/Katello 4.13 (orcharhino 6.11 on EL8 only; orcharhino 7.0 on EL8+EL9)
  • Foreman 3.10/Katello 4.12
  • Foreman 3.9/Katello 4.11 (Satellite 6.15; orcharhino 6.8/6.9/6.10)
  • Foreman 3.8/Katello 4.10
  • Foreman 3.7/Katello 4.9 (Satellite 6.14)
  • We do not accept PRs for Foreman older than 3.7.

Copy link

The PR preview for 7d47d4c is available at theforeman-foreman-documentation-preview-pr-3620.surge.sh

The following output files are affected by this PR:

show diff

show diff as HTML

@Lennonka
Copy link
Contributor

I was trying to introduce a similar deprecation snippet in #3616 - please check it out.
I think that the snippet should be usable in upstream as well - can we ensure that?
Also, it could provide an alternative where available. Please, see my snippet in #3616 for illustration.

@Lennonka
Copy link
Contributor

Can we cherry pick this all the way down, please? I'm going to need it for the bootstrap script deprecation.

@Lennonka
Copy link
Contributor

@maximiliankolb This is the official RH wording -- if you prefer a different wording for orcharhino, now is the time to speak out.

@Lennonka
Copy link
Contributor

We've decided to add the snippet in the scope of #3616. Closing this PR.

@Lennonka Lennonka closed this Jan 28, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants