Add go module for use with new Hugo docs UI #321
Merged
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.
This is a prerequisite for generating previews of the API spec with a local copy of the repo. Once merged, these instructions can be followed to generate those local previews:
From the
feature/new-docs-ui branch
of your docs repo, run:Be sure to replace the local file path of the linode-api-docs repo with the one from your computer.
Run the
hugo server
command with the--ignoreVendor
option:The local server should now live-reload with any changes you make to your local API docs repo.
When you previously ran the
go mod edit -replace
command, a line was added to your docs repo’s go.mod file that looks like this:You should remove this line from that file when you are done testing the API locally.