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

Get rid of {doc-guides} attribute in documentation #36477

Merged
merged 1 commit into from
Oct 25, 2023

Conversation

gsmet
Copy link
Member

@gsmet gsmet commented Oct 13, 2023

It has been mistakenly used in the newest guide that was added as shown in #36474 where we had:

  • one invalid link because of a missing /
  • one invalid link because an incorrect attribute was used

We see it's risky and it has no more value since
we introduced the downstream archive as we automatically transform the links there to point to either a local one or one that is upstream.

IIRC, Michelle already removed some and I don't think it's recommended nowadays.

Note: I haven't handled the getting-started-devservices.adoc here on purpose as Leonor is working on it. Will handle it if needed once Leonor's PR is in.

It has been mistakenly used in the newest guide that was added as shown in
quarkusio#36474 where we had:
- one invalid link because of a missing /
- one invalid link because an incorrect attribute was used

We see it's risky and it has no more value since
we introduced the downstream archive as we automatically transform the
links there to point to either a local one or one that is upstream.

IIRC, Michelle already removed some and I don't think it's recommended
nowadays.

Note: I haven't handled the getting-started-devservices.adoc here on
purpose as Leonor is working on it. Will handle it if needed once
Leonor's PR is in.
@quarkus-bot quarkus-bot bot added area/docstyle issues related for manual docstyle review area/documentation labels Oct 13, 2023
@quarkus-bot quarkus-bot bot added this to To do in Quarkus Documentation Oct 13, 2023
@github-actions
Copy link

github-actions bot commented Oct 13, 2023

🙈 The PR is closed and the preview is expired.

@gsmet gsmet merged commit a36b6a6 into quarkusio:main Oct 25, 2023
5 checks passed
Quarkus Documentation automation moved this from To do to Done Oct 25, 2023
@quarkus-bot quarkus-bot bot added this to the 3.6 - main milestone Oct 25, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/docstyle issues related for manual docstyle review area/documentation
Development

Successfully merging this pull request may close these issues.

None yet

1 participant