Skip to content

Add blicca customization training docs - #1012

Open
petschki wants to merge 10 commits into
mainfrom
blicca-training
Open

petschki wants to merge 10 commits into
mainfrom
blicca-training

Conversation

@petschki

Copy link
Copy Markdown
Member

No description provided.

@stevepiercy

Copy link
Copy Markdown
Member

@petschki would you please update your branch against main and run make linkcheckbroken to ensure that this new branch doesn't introduce any new broken links or redirects, and report back? You can ignore the broken links from other trainings, per #1014.

Also can you ask any colleagues for a technical review?

Those are the only two checks that I really care about.

Thank you!

@petschki
petschki requested a review from thet September 21, 2026 21:39
@petschki

Copy link
Copy Markdown
Member Author

@petschki would you please update your branch against main and run make linkcheckbroken to ensure that this new branch doesn't introduce any new broken links or redirects, and report back? You can ignore the broken links from other trainings, per #1014.

done

Also can you ask any colleagues for a technical review?

will do

@thet

thet commented Sep 29, 2026

Copy link
Copy Markdown
Member

@pbauer @stevepiercy is there a way to reference the docs from another repository, like we do that in the plone documentation? If we put the docs in here like that by copying we would remove them from the original repository, otherwise they probably will go out of sync soon.

@stevepiercy

Copy link
Copy Markdown
Member

@pbauer @stevepiercy is there a way to reference the docs from another repository, like we do that in the plone documentation? If we put the docs in here like that by copying we would remove them from the original repository, otherwise they probably will go out of sync soon.

intersphinx provides support for linking from one Sphinx site to an external and published Sphinx site.

If you want to maintain a single authoritative set of documentation, copying is not the way as you now have two copies to maintain. Instead either move the docs or use git submodules. The downside with git submodules is that it currently requires a manual step to update the docs from the source repository. There is a long-standing open issue to automate this. It sounds like it is now possible.

@stevepiercy

Copy link
Copy Markdown
Member

@petschki @thet what remains to be done to merge this PR?

Did y'all discuss and decide upon how you want to manage the authoritative documentation?

Please let me know. Thank you!

@stevepiercy

Copy link
Copy Markdown
Member

Whoops, looks like this PR introduced broken references that need to be addressed.

https://github.com/plone/training/actions/runs/37231976716/job/111523464522?pr=1012#step:5:492

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: In Progress

Development

Successfully merging this pull request may close these issues.

3 participants