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

Update published xref maps with correctly versioned URL #108

Open
tbpg opened this issue Jul 28, 2021 · 4 comments
Open

Update published xref maps with correctly versioned URL #108

tbpg opened this issue Jul 28, 2021 · 4 comments
Assignees
Labels
type: feature request ‘Nice-to-have’ improvement, new feature or different behavior or design.

Comments

@tbpg
Copy link
Contributor

tbpg commented Jul 28, 2021

Once we have multi-version docs published, we should update our xref maps and regenerate content.

def get_base_url(language, name):
# The baseUrl must start with a scheme and domain. With no scheme, docfx
# assumes it's a file:// link.
base_url = f"https://cloud.google.com/{language}/docs/reference/" + f"{name}/"
# Help packages should not include the version in the URL.
if name != "help":
base_url += "latest/"
return base_url

@tbpg tbpg added the type: feature request ‘Nice-to-have’ improvement, new feature or different behavior or design. label Jul 28, 2021
@tbpg
Copy link
Contributor Author

tbpg commented Jul 7, 2022

@dzlier-gcp, are we good to start this (for the relevant languages)?

@dzlier-gcp
Copy link
Contributor

So I created #298 to address this, but that caused issues in parsing the TOC, so perhaps I misunderstood the purpose of this task. What exactly is the intended change to be made here?

@dzlier-gcp
Copy link
Contributor

Reverted the change in #302 to resolve TOC issue.

@tbpg
Copy link
Contributor Author

tbpg commented Oct 5, 2022

Oops. Looks like get_base_url was deleted. This is the line now:

base_url = f"baseUrl: https://cloud.google.com{get_path(metadata)}/"

That is used for the xrefmap file -- we need to update that, not the TOC. The xref map is used to get cross reference links.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: feature request ‘Nice-to-have’ improvement, new feature or different behavior or design.
Projects
None yet
Development

No branches or pull requests

2 participants