Skip to content

Add go module for use with new Hugo docs UI #321

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

Merged
merged 1 commit into from
Sep 8, 2020

Conversation

nmelehan
Copy link
Contributor

@nmelehan nmelehan commented Sep 8, 2020

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:

  1. From the feature/new-docs-ui branch of your docs repo, run:

     go mod edit -replace github.com/linode/linode-api-docs=/Users/nmelehan/Desktop/linode/linode-api-docs. 
    

    Be sure to replace the local file path of the linode-api-docs repo with the one from your computer.

  2. Run the hugo server command with the --ignoreVendor option:

     hugo server --ignoreVendor
    

    The local server should now live-reload with any changes you make to your local API docs repo.

  3. 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:

     replace github.com/linode/linode-api-docs => /Users/nmelehan/Desktop/linode/linode-api-docs. 
    

    You should remove this line from that file when you are done testing the API locally.

@leslitagordita leslitagordita merged commit 3347cd1 into linode:development Sep 8, 2020
LBGarber pushed a commit to LBGarber/linode-api-docs that referenced this pull request Jun 15, 2022
Master to Development 1.1.50
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.

2 participants