Skip to content

Feat: integrate techdocs repo content into contribute site#218

Merged
nate-double-u merged 19 commits intomainfrom
publish-techdocs
Mar 13, 2026
Merged

Feat: integrate techdocs repo content into contribute site#218
nate-double-u merged 19 commits intomainfrom
publish-techdocs

Conversation

@thisisobate
Copy link
Copy Markdown
Contributor

@thisisobate thisisobate commented Feb 24, 2026

  • I have read and followed the Contributing page.
  • This PR has content that I did not fully write myself.
  • I have the experience and knowledge necessary to understand, review, and validate all content in this PR.1

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

  1. Yes, I can answer maintainer questions about the content of this PR, without using AI.

Signed-off-by: thisisobate <obasiuche62@gmail.com>
@thisisobate thisisobate requested review from a team as code owners February 24, 2026 07:10
@netlify
Copy link
Copy Markdown

netlify Bot commented Feb 24, 2026

Deploy Preview for contribute-cncf-io ready!

Name Link
🔨 Latest commit 2c4e748
🔍 Latest deploy log https://app.netlify.com/projects/contribute-cncf-io/deploys/69b426ce05ee180008bc095e
😎 Deploy Preview https://deploy-preview-218--contribute-cncf-io.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

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>
@nate-double-u
Copy link
Copy Markdown
Member

Thanks @thisisobate! I've made a comment over in cncf/techdocs#338 that i'd like resolved before we merge this in here.

@nate-double-u nate-double-u self-requested a review February 24, 2026 18:26
@nate-double-u
Copy link
Copy Markdown
Member

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 edit this page links.

@thisisobate
Copy link
Copy Markdown
Contributor Author

Ok. Let me have a look

@thisisobate
Copy link
Copy Markdown
Contributor Author

@nate-double-u Would you advise we add the analyses folder containing all past techdocs analysis for CNCF projects to the new contribute site? Currently, we have just the docs folder show within the contribute site.

@nate-double-u
Copy link
Copy Markdown
Member

nate-double-u commented Feb 27, 2026

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>
@thisisobate
Copy link
Copy Markdown
Contributor Author

thisisobate commented Mar 3, 2026

Yes, we should publish those here, too

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

@nate-double-u
Copy link
Copy Markdown
Member

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

Yes, and I think they should show up under the /techdocs/ folder (like /techdocs/analyses). I don't think there are any conflicts there so it should work.

Signed-off-by: thisisobate <obasiuche62@gmail.com>
Signed-off-by: thisisobate <obasiuche62@gmail.com>
Copy link
Copy Markdown
Member

@nate-double-u nate-double-u left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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).

Comment thread package.json Outdated
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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/techdocs docs + analyses into docs/techdocs, plus a link-normalization step for synced analyses.
  • Add an autogenerated techdocsSidebar and a “TechDocs” navbar entry to expose the synced content in the site UI.
  • Update docs editUrl logic to route edit links to cncf/techdocs for 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.

Comment thread package.json Outdated
Comment thread scripts/sync-techdocs-docs.sh
Comment thread scripts/sync-techdocs-docs.sh
Comment thread docusaurus.config.js
Comment thread sidebars.js Outdated
Comment thread package.json Outdated
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>
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread package.json Outdated
Signed-off-by: thisisobate <obasiuche62@gmail.com>
Copy link
Copy Markdown
Member

@nate-double-u nate-double-u left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this looks good, thanks @thisisobate, great work!

@nate-double-u nate-double-u merged commit aa046c9 into main Mar 13, 2026
5 checks passed
@nate-double-u nate-double-u deleted the publish-techdocs branch March 13, 2026 15:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants