Skip to content

Update api doc urls to point to techdocs #439

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

Merged
merged 2 commits into from
Jul 23, 2024

Conversation

jriddle-linode
Copy link
Collaborator

📝 Description

What does this PR do and why is this change necessary?

Updates any api doc urls to point to https://techdocs.akamai.com/linode-api/reference/api

@jriddle-linode jriddle-linode requested a review from a team as a code owner July 16, 2024 14:43
@jriddle-linode jriddle-linode added the documentation for updates to the documentation in the changelog. label Jul 16, 2024
@jriddle-linode jriddle-linode requested review from zliang-akamai and ykim-akamai and removed request for a team July 16, 2024 14:43
Copy link
Contributor

@ykim-akamai ykim-akamai 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
Contributor

@lgarber-akamai lgarber-akamai left a comment

Choose a reason for hiding this comment

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

Looks like there are still some residual legacy docs URLs in the docstrings: https://github.com/linode/linode_api4-python/blob/dev/linode_api4/objects/account.py#L29

You should be able to automatically convert all of these URLs using this tool: https://github.com/lgarber-akamai/linode-legacy-to-techdocs

e.g.

pip install --force git+https://github.com/lgarber-akamai/linode-legacy-to-techdocs.git && \
find ./linode_api4 -type f -name '*.py' | xargs legacy-to-techdocs replace -w -f 

Copy link
Contributor

@lgarber-akamai lgarber-akamai left a comment

Choose a reason for hiding this comment

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

Looks great!

@jriddle-linode jriddle-linode merged commit 72481ad into linode:dev Jul 23, 2024
7 checks passed
@jriddle-linode jriddle-linode deleted the docs/techdocs branch July 23, 2024 15:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation for updates to the documentation in the changelog.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants