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

Replace broken links with relative links in API-linting-Implementation-Guideline.md #274

Merged
merged 10 commits into from
Aug 21, 2024

Conversation

eric-murray
Copy link
Collaborator

What type of PR is this?

  • documentation
  • correction

What this PR does / why we need it:

Some links in API-linting-Implementation-Guideline.md are broken. This PR replaces all internal links in the document (broken or otherwise) with relative links.

Which issue(s) this PR fixes:

N/A

Special notes for reviewers:

None

Changelog input

 release-note
 - Replace broken links with relative links in API-linting-Implementation-Guideline.md

Additional documentation

None

@hdamker
Copy link
Collaborator

hdamker commented Aug 5, 2024

Looks good to me.

Just that instead of ../artifacts also /artifacts works (and survives in case the API-linting-Implementation-Guideline would be moved into a sub directory of /documentation at some point).

@eric-murray
Copy link
Collaborator Author

You're right - it does work! This is obviously some "smart" implementation of relative links that my Unix experience has left me poorly prepared for. No doubt this is documented somewhere, but whilst I search for that, I updated the PR with the minimal relative links that still worked. Hopefully this document is now even more "future proof".

@hdamker
Copy link
Collaborator

hdamker commented Aug 5, 2024

PedroDiez
PedroDiez previously approved these changes Aug 6, 2024
Copy link
Collaborator

@PedroDiez PedroDiez left a comment

Choose a reason for hiding this comment

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

Minor suggestions

LGTM in advance

documentation/API-linting-Implementation-Guideline.md Outdated Show resolved Hide resolved
documentation/API-linting-Implementation-Guideline.md Outdated Show resolved Hide resolved
documentation/API-linting-Implementation-Guideline.md Outdated Show resolved Hide resolved
documentation/API-linting-Implementation-Guideline.md Outdated Show resolved Hide resolved
eric-murray and others added 6 commits August 9, 2024 16:23
Co-authored-by: Pedro Díez García <pedro.diezgarcia@telefonica.com>
Co-authored-by: Pedro Díez García <pedro.diezgarcia@telefonica.com>
Co-authored-by: Pedro Díez García <pedro.diezgarcia@telefonica.com>
Co-authored-by: Pedro Díez García <pedro.diezgarcia@telefonica.com>
Copy link
Collaborator

@PedroDiez PedroDiez left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Collaborator

@bigludo7 bigludo7 left a comment

Choose a reason for hiding this comment

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

Approve on behalf of @patrice-conil for Orange team

Copy link
Collaborator

@shilpa-padgaonkar shilpa-padgaonkar left a comment

Choose a reason for hiding this comment

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

/LGTM

@rartych rartych merged commit 36a98ef into camaraproject:main Aug 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
correction correction in documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants