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 documentation url for 'can()' and 'try()' #13022

Closed

Conversation

gitbisect
Copy link

the urls to can and try files referencing each other are messed up. This PR will fix the URLs

Copy link

hashicorp-cla-app bot commented Jun 5, 2024

CLA assistant check
All committers have signed the CLA.

@gitbisect gitbisect changed the title [WIP] fix url for can and try Fix documentation url for 'can()' and 'try()' Jun 5, 2024
@gitbisect gitbisect marked this pull request as ready for review June 5, 2024 17:47
@gitbisect gitbisect requested a review from a team as a code owner June 5, 2024 17:47
@gitbisect
Copy link
Author

I understand this requires an approval. But I am not sure about what to do with "Vercel — Authorization required to deploy." Am I supposed to authorize it? Which I think I have done. Or is it an maintainer that needs to authorize it. Please help.

@lbajolet-hashicorp
Copy link
Contributor

lbajolet-hashicorp commented Jun 5, 2024

Hey @gitbisect,

Approved, don't worry about vercel that's for doc previews, it's not a blocker.

That being said, may I ask what are you trying to solve? The links are relative to the production environment, and there's a linter that is on the lookout for links like yours.
I've looked at those pages on the developer docs site, and they do redirect as expected, have you experienced something different?

@gitbisect
Copy link
Author

Hi @lbajolet-hashicorp
Thanks for the quick response. Actually the links don't redirect as expected for someone trying to look at the doc from a google search for example. Here is a link. https://github.com/hashicorp/packer/blob/main/website/content/docs/templates/hcl_templates/functions/conversion/can.mdx

I was looking at this because I wanted to see the documentation for can(). Now there are 3 links from there to try() recommending that we should use try. If you click on those links, they all lead to a 404. Here is the screenshot.
image

The actual destination page is https://github.com/hashicorp/packer/blob/main/website/content/docs/templates/hcl_templates/functions/conversion/try.mdx
Even in that page, there is a link back to the can document and that also goes to a 404 response.

@lbajolet-hashicorp
Copy link
Contributor

Hi @gitbisect,

That is actually expected, the docs we have here are viewable on Github since they're markdown files, but the intent is to upload them to https://developer.hashicorp.com, our documentation website.

For example the functions you mention are respectively at:

Here, the links render correctly, and I'm not certain we can fix it in one place, and not break it in another, so I believe we should keep the existing links.

That being said let me know if you have something else to suggest or questions, but I'd be enclined to close this PR as it's unlikely we can accept this in the current state.

@lbajolet-hashicorp lbajolet-hashicorp added the invalid Out of scope/alignment with the project, or issue is expected, intended behavior label Jun 6, 2024
@gitbisect
Copy link
Author

Perfect. Thanks.

@gitbisect gitbisect closed this Jun 6, 2024
@gitbisect gitbisect deleted the gitbisect/fix-url-for-can-and-try branch June 6, 2024 13:57
@gitbisect gitbisect restored the gitbisect/fix-url-for-can-and-try branch June 6, 2024 13:57
@gitbisect gitbisect deleted the gitbisect/fix-url-for-can-and-try branch June 6, 2024 13:59
Copy link

github-actions bot commented Jul 7, 2024

I'm going to lock this pull request because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues.
If you have found a problem that seems related to this change, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jul 7, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
invalid Out of scope/alignment with the project, or issue is expected, intended behavior
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants