Improvements to local serving #1204
Conversation
| # The Satellite build uses links which do not resolve. This does mean the link | ||
| # checker has issues with verification of guides that have not yet been built | ||
| # by downstream, but there really isn't a way around this unless we start | ||
| # building with downstream filenames. | ||
| ifneq ($(BUILD), satellite) |
There was a problem hiding this comment.
I wonder if this is still valid.
|
The PR preview for 706b18a is available at theforeman-foreman-documentation-preview-pr-1204.surge.sh The following output files are affected by this PR: |
|
@evgeni does that mean you approve and it can be merged? |
|
I didn't test it, so can't really approve, but the concern I had is solved. |
Makefile
Outdated
| ifeq ($(LINKS), SERVE) | ||
| BASEURL := http://localhost:$(PORT)/ | ||
| endif | ||
| VERSION_LINKS := 3.4 3.3 3.2 3.1 3.0 2.5 2.4 |
There was a problem hiding this comment.
We should probably extend the procedure "how to add a new Foreman version" to ensure this list is also extended with 3.5.
|
I've rebased this and it works for me. Can we merge this before it gets out of date again? |
|
While testing this out I found it's annoying that it's not really live. Currently investigating nanoc with live serving. |
|
This now takes the approach of serving everything through nanoc, including the built guides. I'm still not quite happy with it, but pushing my work since it's a better direction. |
pr-processor
bot
added
Needs re-review
and removed
Waiting on contributor
|
Rebased to resolve some conflicts, but no real change. #2840 is related work that I want to build on. |
When developing locally it's good to check the cross links work correctly. Especially when chapters aren't available on docs.theforeman.org.
4 participants
See individual commits for details, but the important part is that with this the cross document links are correctly linking to the local site rather than production.