Change dir in documentation GH action to contain multiple HTML pages #46
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
austin-denoble
approved these changes
Jul 17, 2024
7 tasks
aulorbe
added a commit
that referenced
this pull request
Jul 17, 2024
## Problem We tried a variety of different solutions for pushing static documentation to our GH pages site (see `sdk-docs` repo for more information), but the rendering was very bad. Related PRs: - #41 - #42 - #43 - #44 - #45 - #46 ## Solution - Simply use the default hosting site of pkg.go.dev, and include instructions for visiting the documentation on `main` vs the latest release-version's documentation. - Changed the documentation badge to point to latest documentation on `main` instead of latest versioned-release's documentation. - Remove GH workflow and action files ## Type of Change - [ ] Bug fix (non-breaking change which fixes an issue) - [ ] New feature (non-breaking change which adds functionality) - [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) - [x] This change requires a documentation update - [ ] Infrastructure change (CI configs, etc) - [ ] Non-code change (docs, etc) - [ ] None of the above: (explain here)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Problem
In the original
gopagesPR, I was under the impression that we could only push a singleindex.htmlfile to thesdk-docsrepo. Upon inspecting the other clients' dirs insdk-docs, though, I realized we could push a dir containing many different html pages in it.Solution
Point action to entire dir (
dist) that contains multiple html files.Type of Change
Test Plan
Merge to main, trigger build documentation workflow in this repo, trigger publish documentation workflow in
sdk-docsrepo, see if rendering is better.