Skip to content

[Update] Docs UI Links #327

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 5 commits into from
Oct 20, 2020

Conversation

hzoppetti
Copy link
Contributor

updating links for new docs ui

@hzoppetti hzoppetti changed the base branch from development to feature/new-docs-ui September 15, 2020 21:42
@leslitagordita leslitagordita changed the base branch from feature/new-docs-ui to development September 16, 2020 20:18
@leslitagordita leslitagordita changed the base branch from development to feature/new-docs-ui September 16, 2020 20:20
@@ -17,7 +17,7 @@ info:
This document was generated from our OpenAPI Specification. See the
<a target="_top" href="https://www.openapis.org">OpenAPI website</a> for more information.

<a target="_top" href="https://developers.linode.com/api/docs/v4/openapi.yaml">Download the Linode OpenAPI Specification</a>.
<a target="_top" href="/docs/api/openapi.yaml">Download the Linode OpenAPI Specification</a>.
Copy link
Contributor

@leslitagordita leslitagordita Sep 16, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When I build locally, this is a 404. When I look through the docs site directories, I see this file located here: _vendor/github.com/linode/linode-api-docs/openapi.yaml. Were you able to access the file in your local build of new docs? I tried building using both using the local spec file path and the github repo path.

Copy link
Contributor

@leslitagordita leslitagordita Sep 16, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@hzoppetti confirmed she was able to download locally. I rebuilt and am able to download the spec file now.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So, the _vendor path is just where Hugo copies in the API spec file "internally" -- it doesn't map directly onto the URL structure that it ultimately renders to.

I think the issue here is that our implementation of the API in the new UI doesn't actually publish the literal openapi.yaml file. It only publishes the markdown pages that a human would read through (at /docs/api/). In other words, if we were publishing the spec file itself, it would appear in the following output; this command is run from the root of the docs repo in the feature/new-docs-ui branch, after having previously run hugo (or hugo75) to build the site:

ls public/api
account                      index.json                   linode-types                 nodebalancers                stackscripts
domains                      key                          longview                     object-storage               support
images                       linode-instances             managed                      profile                      tags
index.html                   linode-kubernetes-engine-lke networking                   regions                      volumes

We can ask Bjorn to render the spec file (would just need to make an issue in our issue tracker repo).

@leslitagordita
Copy link
Contributor

Also, all other link updates look good to me. Just have that open question about the openapi.yaml file.

@leslitagordita leslitagordita self-requested a review September 16, 2020 20:39
@hzoppetti hzoppetti merged commit c06c6ab into linode:feature/new-docs-ui Oct 20, 2020
LBGarber pushed a commit to LBGarber/linode-api-docs that referenced this pull request Jun 15, 2022
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