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 API Docs paths/structure #63

Merged
merged 13 commits into from
Oct 5, 2021
Merged

Update API Docs paths/structure #63

merged 13 commits into from
Oct 5, 2021

Conversation

djgrove
Copy link
Member

@djgrove djgrove commented Oct 4, 2021

A few changes to support the docs being generated in a new location.

  • Removed all content files for registry/packages/<package>/api.docs.md as these files are now generated properly.
  • Added breadcrumbs for the API docs page in addition to How-to Guides.
  • Updated several relref paths to point to the new location of API docs.
  • [Make the code better] Fixed the UI for the How-to Guides count pill when it is selected to be filled purple.

@github-actions
Copy link

github-actions bot commented Oct 4, 2021

Your site preview for commit 4d85db9 is ready! 🎉

http://registry-origin-pr-63-4d85db96.s3-website.us-west-2.amazonaws.com.

@github-actions
Copy link

github-actions bot commented Oct 4, 2021

Your site preview for commit 19b10ab is ready! 🎉

http://registry-origin-pr-63-19b10ab0.s3-website.us-west-2.amazonaws.com.

@github-actions
Copy link

github-actions bot commented Oct 5, 2021

Your site preview for commit 392f2bd is ready! 🎉

http://registry-origin-pr-63-392f2bd1.s3-website.us-west-2.amazonaws.com.

@github-actions
Copy link

github-actions bot commented Oct 5, 2021

Your site preview for commit 6a83889 is ready! 🎉

http://registry-origin-pr-63-6a838890.s3-website.us-west-2.amazonaws.com.

@github-actions
Copy link

github-actions bot commented Oct 5, 2021

Your site preview for commit 2fd4897 is ready! 🎉

http://registry-origin-pr-63-2fd4897f.s3-website.us-west-2.amazonaws.com.

@djgrove djgrove marked this pull request as ready for review October 5, 2021 20:04
@kimberleyamackenzie
Copy link
Collaborator

I'm not sure if it's just me, but looking at the latest preview link, when I click the API Docs tab on a package, nothing happens - the tab content doesn't load, the tab doesn't get active styles, etc.

@djgrove
Copy link
Member Author

djgrove commented Oct 5, 2021

I'm not sure if it's just me, but looking at the latest preview link, when I click the API Docs tab on a package, nothing happens - the tab content doesn't load, the tab doesn't get active styles, etc.

Yeah, the problem with this is that the API docs are generated in the docs repo which builds the full site--so they aren't present in the build here. These GH Actions based builds of the Registry are becoming a little less useful to us now that we are doing all this work with the API docs.

@djgrove djgrove mentioned this pull request Oct 5, 2021
8 tasks
@github-actions
Copy link

github-actions bot commented Oct 5, 2021

Your site preview for commit ae7dec5 is ready! 🎉

http://registry-origin-pr-63-ae7dec5f.s3-website.us-west-2.amazonaws.com.

@praneetloke
Copy link
Contributor

@kimberleyamackenzie @djgrove yeah we definitely need to have another conversation about moving the API docs from the docs repo to this repo. It'll make a few things better.

@praneetloke
Copy link
Contributor

Hmm @djgrove as Kimberley said I expected to at least see that the active tab would change when I click on the API Docs tab but with no API docs in there because they are all in docs repo. Is that what you would expect as well with the latest updates? Just making sure we are talking about the same thing.

@djgrove
Copy link
Member Author

djgrove commented Oct 5, 2021

Hmm @djgrove as Kimberley said I expected to at least see that the active tab would change when I click on the API Docs tab but with no API docs in there because they are all in docs repo. Is that what you would expect as well with the latest updates? Just making sure we are talking about the same thing.

No, this is expected. The API Docs <package_name>/api-docs/_index.md is generated. We previously had a placeholder in place here, but I had to removed that now that the generated templates are going to the correct path.

@praneetloke
Copy link
Contributor

@djgrove that makes sense. I also noticed that you deleted the cloudfx folder with this PR. Thank you for doing that. Kimberley and I were just chatting about that one.

@djgrove djgrove merged commit 4c29da9 into master Oct 5, 2021
@pulumi-bot pulumi-bot deleted the devon/api-docs-paths branch October 5, 2021 23:47
@github-actions
Copy link

github-actions bot commented Oct 5, 2021

Site previews for this pull request have been removed. ✨

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