Feat: integrate techdocs repo content into contribute site#218
Feat: integrate techdocs repo content into contribute site#218nate-double-u merged 19 commits intomainfrom
Conversation
Signed-off-by: thisisobate <obasiuche62@gmail.com>
✅ Deploy Preview for contribute-cncf-io ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Signed-off-by: thisisobate <obasiuche62@gmail.com>
Signed-off-by: thisisobate <obasiuche62@gmail.com>
|
Thanks @thisisobate! I've made a comment over in cncf/techdocs#338 that i'd like resolved before we merge this in here. |
|
Also, for this set of pages, we may need to make an update to the template, https://deploy-preview-218--contribute-cncf-io.netlify.app/techdocs/ - specifically the |
|
Ok. Let me have a look |
|
@nate-double-u Would you advise we add the |
|
Yes, we should publish those here, too. |
Signed-off-by: thisisobate <obasiuche62@gmail.com>
Signed-off-by: thisisobate <obasiuche62@gmail.com>
Signed-off-by: thisisobate <obasiuche62@gmail.com>
Signed-off-by: thisisobate <obasiuche62@gmail.com>
Signed-off-by: thisisobate <obasiuche62@gmail.com>
I just realized publishing the analyses breaks almost all their relative links. Is it worth writing yet another script to normalize links just to have these show up on the website? @nate-double-u cc: @chalin |
Yes, and I think they should show up under the |
Signed-off-by: thisisobate <obasiuche62@gmail.com>
Signed-off-by: thisisobate <obasiuche62@gmail.com>
nate-double-u
left a comment
There was a problem hiding this comment.
We should add docs/techdocs/ to the .gitignore
Since docs/techdocs/ is generated at build time by the sync script, it should be gitignored. Without this, a developer who runs the sync locally could accidentally commit 13,000+ lines of fetched content.
We should also add this new workflow to the site README file (seems like a dev would need to run the script locally if they want to see the whole site on their machine).
There was a problem hiding this comment.
Pull request overview
Integrates content from the external cncf/techdocs repository into this Docusaurus site by syncing TechDocs content during builds, adding a dedicated TechDocs sidebar/nav entry, and mapping “Edit this page” links back to the upstream repo where appropriate.
Changes:
- Add a build-time sync script to fetch
cncf/techdocsdocs + analyses intodocs/techdocs, plus a link-normalization step for synced analyses. - Add an autogenerated
techdocsSidebarand a “TechDocs” navbar entry to expose the synced content in the site UI. - Update docs
editUrllogic to route edit links tocncf/techdocsfor synced pages and to this repo for native pages.
Reviewed changes
Copilot reviewed 5 out of 6 changed files in this pull request and generated 6 comments.
Show a summary per file
| File | Description |
|---|---|
sidebars.js |
Adds techdocsSidebar autogenerated from docs/techdocs. |
scripts/sync-techdocs-docs.sh |
Clones cncf/techdocs and copies docs/analyses into docs/techdocs, then runs link normalization. |
scripts/normalize_analyses_links.py |
Rewrites certain relative links inside synced analyses markdown to reduce broken links. |
package.json |
Runs TechDocs sync as part of Netlify build scripts; adds @docusaurus/plugin-content-docs dependency. |
docusaurus.config.js |
Adds edit-link routing logic for synced TechDocs content; adds TechDocs navbar item; plugin array formatting tweak. |
You can also share your feedback on Copilot code review. Take the survey.
Signed-off-by: thisisobate <obasiuche62@gmail.com>
Signed-off-by: thisisobate <obasiuche62@gmail.com>
…ild fails Signed-off-by: thisisobate <obasiuche62@gmail.com>
…echdocs Signed-off-by: thisisobate <obasiuche62@gmail.com>
Signed-off-by: thisisobate <obasiuche62@gmail.com>
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 6 out of 8 changed files in this pull request and generated 1 comment.
You can also share your feedback on Copilot code review. Take the survey.
Signed-off-by: thisisobate <obasiuche62@gmail.com>
nate-double-u
left a comment
There was a problem hiding this comment.
I think this looks good, thanks @thisisobate, great work!
Preferred Solution
I am adopting the build-time fetch + deploy approach. This is the only approach that truly makes contribute-site always reflect the latest cncf/techdocs@main without a PR/merge step. A submodule/subtree would still require updating a pinned commit in contribute-site.
Next steps
Relates to cncf/techdocs#54
Footnotes
Yes, I can answer maintainer questions about the content of this PR, without using AI. ↩