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

Docs: Link to registry-rule-types doesn't work #871

Closed
EricWittmann opened this issue Sep 23, 2020 · 4 comments
Closed

Docs: Link to registry-rule-types doesn't work #871

EricWittmann opened this issue Sep 23, 2020 · 4 comments
Assignees

Comments

@EricWittmann
Copy link
Member

This might be the case for any link that goes from one "guide" to another, but so far I've only noticed it for registry-rule-types. Example: on this page:

https://www.apicur.io/registry/docs/apicurio-registry/getting-started/assembly-intro-to-registry-rules.html#registry-rules-work

There is the following link at the bottom:

image

The link has an href of:

https://www.apicur.io/registry/docs/apicurio-registry/getting-started/assembly-intro-to-registry-rules.html#registry-rule-types

But that doesn't work. It should be this:

https://www.apicur.io/registry/docs/apicurio-registry/getting-started/assembly-registry-reference.html#registry-rule-types

@smccarthy-ie
Copy link
Contributor

Hey @EricWittmann, @cfoskin

I think this is because the playbook used to automate the doc build is missing the required attributes to make the cross-reference links work:
https://github.com/Apicurio/apicurio-docs-playbook/blob/master/registry-docs-playbook.yml

These attribute links have already been added in the playbook used for local testing:
https://github.com/Apicurio/apicurio-registry/blob/master/docs/local-test-playbook.yml

So the fix should be to keep both playbooks in sync. Thanks.

@smccarthy-ie
Copy link
Contributor

smccarthy-ie commented Sep 24, 2020

BTW, the links to the "Apicurio Registry REST API documentation" are also broken, giving 404s. For example, in https://www.apicur.io/registry/docs/apicurio-registry/getting-started/assembly-intro-to-the-registry.html#registry-rest-api

In this case, the fix is to ensure that the automated doc build picks up the registry-rest-api.htm file from
https://github.com/Apicurio/apicurio-registry/tree/master/docs/modules/ROOT/assets/attachments
and puts it in
https://www.apicur.io/registry/docs/apicurio-registry/_attachments/registry-rest-api.htm

@smccarthy-ie
Copy link
Contributor

Hi @EricWittmann,
When I build now locally using https://github.com/Apicurio/apicurio-docs-playbook, all the broken links are fixed :) Thanks!

So it looks like the latest fixed doc build just needs to be pushed to the website now? I'm keen to resolve this one now that IBM are also looking at our new docs website :)

@EricWittmann
Copy link
Member Author

Fixed in Apicurio/apicurio.github.io@b84b989

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

No branches or pull requests

3 participants