Skip to content

[fix][doc] Replace reference-configuration page with an external link - #17699

Merged
urfreespace merged 1 commit into
apache:masterfrom
SignorMercurio:docs/remove-conf
Sep 20, 2022
Merged

[fix][doc] Replace reference-configuration page with an external link#17699
urfreespace merged 1 commit into
apache:masterfrom
SignorMercurio:docs/remove-conf

Conversation

@SignorMercurio

Copy link
Copy Markdown
Contributor

Motivation

The link Pulsar reference points to /reference, which is handled by Docusaurus as an SPA page and will result in 404. This is a known limitation of Docusaurus(facebook/docusaurus#3309) and the known workaround does not work well either.

Modifications

Therefore, we decided to use an external link in the sidebar to redirect users to /reference directly.

Verifying this change

  • Make sure that the change passes the CI checks.

This change is a trivial rework / code cleanup without any test coverage.

Does this pull request potentially affect one of the following parts:

If the box was checked, please highlight the changes

  • Dependencies (add or upgrade a dependency)
  • The public API
  • The schema
  • The default values of configurations
  • The binary protocol
  • The REST endpoints
  • The admin CLI options
  • Anything that affects deployment

Documentation

  • doc-required
    (Your PR needs to update docs and you will update later)

  • doc-not-needed
    (Please explain why)

  • doc
    (Your PR contains doc changes)

  • doc-complete
    (Docs have been already added)

Signed-off-by: Mercurio <signormercurio@gmail.com>
@github-actions github-actions Bot added the doc Your PR contains doc changes, no matter whether the changes are in markdown or code files. label Sep 17, 2022
@urfreespace
urfreespace merged commit bf6e815 into apache:master Sep 20, 2022
@SignorMercurio
SignorMercurio deleted the docs/remove-conf branch September 20, 2022 01:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

doc Your PR contains doc changes, no matter whether the changes are in markdown or code files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants