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.

Sign up for GitHub

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

Jump to bottom

Wrong links from second page on #827

Closed
nicolaferraro opened this issue Jul 17, 2019 · 3 comments · Fixed by #831
Closed

Wrong links from second page on #827

nicolaferraro opened this issue Jul 17, 2019 · 3 comments · Fixed by #831
Assignees
@zregvart
Labels
area/documentation Documentation task kind/bug Something isn't working
Milestone
1.0.0

Comments

@nicolaferraro
Copy link
Member

Some links point to the wrong location.

E.g.
"Minikube" on the home page is ok.
"Minikube" from the "Local cluster setup guide" is wrong ("/installation/installation/...").

@zregvart any clue? Does it work on Antora?
@nicolaferraro nicolaferraro added kind/bug Something isn't working area/documentation Documentation task labels Jul 17, 2019
@nicolaferraro nicolaferraro added this to the 1.0.0 milestone Jul 17, 2019
@zregvart zregvart self-assigned this Jul 17, 2019
@zregvart
Copy link
Member

I'll have a look, I had some issues rebasing so I probably overlooked this.

@zregvart
Copy link
Member

I've had a look, the links work fine from the rendered Antora, the xref: links in Antora are specified from the module path onward. The only way I see this to work across GitHub and rendered Antora is to flatten all documents into docs/modules/ROOT/pages and not use topics to organize content.

How important is that the links work on GitHub? Perhaps we can change the links in the README.adoc to point to the staging site?

@nicolaferraro
Copy link
Member Author

Yeah, I had a similar issue when I tried the first migration to Antora.

Linking staging (and later the main website) from the main README.adoc sounds like a good plan.

zregvart added a commit to zregvart/camel-k that referenced this issue Jul 17, 2019
@zregvart
fix: point to the staging site from README.adoc
2c260ad 
Changes all `xref` links in the README.adoc to point to the staging site
where the `docs/` content is rendered.

Be aware that there is no link between the `camel-website` build and the
`camel-k` repository, that is to say changes to the `camel-k` git
repository will not be reflected on the website until the website build
is run[1]. There's an open issue to trigger the website build on changes
to the documentation in the other repositories[2].

Fixes apache#827

[1] https://builds.apache.org/job/Camel.website/job/master/
[2] https://issues.apache.org/jira/browse/CAMEL-13753
@zregvart zregvart mentioned this issue Jul 17, 2019
Merged
ipolyzos pushed a commit to ipolyzos/camel-k that referenced this issue Jul 31, 2019
@zregvart @ipolyzos
fix: point to the staging site from README.adoc
be679a7 
Changes all `xref` links in the README.adoc to point to the staging site
where the `docs/` content is rendered.

Be aware that there is no link between the `camel-website` build and the
`camel-k` repository, that is to say changes to the `camel-k` git
repository will not be reflected on the website until the website build
is run[1]. There's an open issue to trigger the website build on changes
to the documentation in the other repositories[2].

Fixes apache#827

[1] https://builds.apache.org/job/Camel.website/job/master/
[2] https://issues.apache.org/jira/browse/CAMEL-13753
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@zregvart zregvart

Labels
area/documentation Documentation task kind/bug Something isn't working
Projects
None yet
Milestone
1.0.0
Development

Successfully merging a pull request may close this issue.

fix: point to the staging site from README.adoc zregvart/camel-k
2 participants
@zregvart @nicolaferraro