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

CAMEL-13817: Change Getting Started links #108

Merged
merged 4 commits into from Nov 14, 2019
Merged

Conversation

@omarsmak
Copy link
Member

omarsmak commented Nov 13, 2019

Hey @zregvart can you please take a look at it if what I did makes sense? Thanks

Signed-off-by: Omar Al-Safi <omarsmak@gmail.com>
@omarsmak omarsmak requested a review from zregvart Nov 13, 2019
@zregvart

This comment has been minimized.

Copy link
Contributor

zregvart commented Nov 13, 2019

Perhaps it would make sense to remove the content/docs/getting-started.md and add a redirect from /docs/getting-started/ to /manual/latest/getting-started.html in static/.htaccess.

Signed-off-by: Omar Al-Safi <omarsmak@gmail.com>
@omarsmak

This comment has been minimized.

Copy link
Member Author

omarsmak commented Nov 13, 2019

Sure, I have deleted the old file and added the redirection

@omarsmak

This comment has been minimized.

Copy link
Member Author

omarsmak commented Nov 13, 2019

@zregvart Jenkins build has failed for some reason, is this a hiccup or there is a specific reason? I can't figure out why it has failed

@bedlaj

This comment has been minimized.

Copy link
Contributor

bedlaj commented Nov 14, 2019

It was just timeout during docker stop. Nothing to worry about. I have restarted the job and now it is failing on real check:
[2019-11-13T23:57:34.330Z] page not found from acknowledgments/index.html to docs/getting-started/index.html

@zregvart

This comment has been minimized.

Copy link
Contributor

zregvart commented Nov 14, 2019

Yeah, we have a check for broken links, this needs to be updated also:

<a class="significant" href="./docs/getting-started/">Get started</a>

@omarsmak

This comment has been minimized.

Copy link
Member Author

omarsmak commented Nov 14, 2019

@bedlaj thanks a lot, I forgot that I can now actually restart the builds :).
@zregvart actually this file was also changed by this PR as well

<a class="significant" href="/manual/latest/getting-started.html">Get started</a>

Weird enough that when I run the same checks locally, I don't get any errors:

yarn --non-interactive --frozen-lockfile checks                                                  oalsafi@LT-C02YV0PGLVDR
yarn run v1.19.1
$ run-s check:*
$ antora --generator @antora/xref-validator site.yml
$ link-checker --disable-external --mkdocs --allow-hash-href public

2192 files were scanned in public
9939 local links and 0 parent links and 0 remote links were checked
0 errors and 0 warnings
$ html-validate 'public/*/**/*.html' 'public/!(google)*.html'
✨  Done in 111.47s.
@zregvart

This comment has been minimized.

Copy link
Contributor

zregvart commented Nov 14, 2019

@omarsmak did you run the build first (`yarn build)? We trust in the website CI build to catch the broken links.

I misread, @bedlaj was correct its this file:

<dd><a href="/docs/getting-started/">Getting started</a></dd>

@omarsmak

This comment has been minimized.

Copy link
Member Author

omarsmak commented Nov 14, 2019

@zregvart actually I was doing yarn build always. Somehow I got the checks to work, I had to delete the generated public folder and then re-run yarn build, I was under the assumption the generated files will be overwritten whenever I do yarn build. Sorry, first time working with yarn :D

@zregvart

This comment has been minimized.

Copy link
Contributor

zregvart commented Nov 14, 2019

One last one (I hope):

<dd><a href="{{siteRootPath}}/docs/getting-started/">Getting started</a></dd>

Signed-off-by: Omar Al-Safi <omarsmak@gmail.com>
@zregvart

This comment has been minimized.

Copy link
Contributor

zregvart commented Nov 14, 2019

@zregvart zregvart merged commit 8da4696 into master Nov 14, 2019
1 check passed
1 check passed
continuous-integration/jenkins/pr-merge This commit looks good
Details
@zregvart zregvart deleted the pr/deduplicate-getting-started branch Nov 14, 2019
@zregvart

This comment has been minimized.

Copy link
Contributor

zregvart commented Nov 14, 2019

Thanks @omarsmak!

@omarsmak

This comment has been minimized.

Copy link
Member Author

omarsmak commented Nov 14, 2019

No problem! Happy to help :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
3 participants
You can’t perform that action at this time.