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

fix: use full url for linking to api doc #459

Merged
merged 3 commits into from
Sep 7, 2020
Merged

Conversation

jjtang1985
Copy link
Contributor

Context

I made a mistake to commit to the document branch directly, which tried to use the useBaseUrl .
Switched to the full url.

Here is an related issue, saying there can be false positive and how to disable it via config.
However, the config is about to change navbar/footer items, which is not applicable in our case.

Definition of Done

Please consider all items and remove only if not applicable.

  • Tests created/adjusted for your changes.
  • Release notes updated.
    • Provide sufficient context so that each entry can be understood on its own.
    • Be specific about names of functions, classes, modules, etc.
    • Describe when or where this is relevant
    • Use indicative and present tense. For example, write "Provide function name that does X in order to Y" over "Now X can be done by calling a new function".
  • PR title adheres to conventional commit guidelines (please note that only fix: and feat: will end up in the release notes)
  • If applicable: Properly documented (JSDoc of public API)
  • If applicable: Check if node run doc still works.

@jjtang1985 jjtang1985 requested a review from marikaner September 7, 2020 10:08
@jjtang1985 jjtang1985 changed the title use full url fix: use full url for linking to api doc Sep 7, 2020
Copy link
Contributor

@FrankEssenberger FrankEssenberger left a comment

Choose a reason for hiding this comment

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

Fine for me, but what will happen locally? The link will point to the internet and not the local static copy of the API right?

@marikaner marikaner merged commit 2479453 into documentation Sep 7, 2020
@marikaner marikaner deleted the fix-doc-master branch September 7, 2020 17:06
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