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

import most vendored files into this repo #11

Closed
5 tasks done
clux opened this issue Mar 7, 2022 · 0 comments · Fixed by #16
Closed
5 tasks done

import most vendored files into this repo #11

clux opened this issue Mar 7, 2022 · 0 comments · Fixed by #16
Assignees

Comments

@clux
Copy link
Member

clux commented Mar 7, 2022

Having canonical versions outside the website repo is awkward for editing of this website. Vendoring is unexpected and complicates contributions, and many files do not need to be at the org level.

stuff easy to move

stuff hard to move

  • CONTRIBUTING (from kube-rs and mirrored in .github repo) - shows up on PR creation as suggestion
  • SECURITY (from kube-rs and mirrored in .github repo) - shows up as security policy when creating issues

these files could be replaced with a stub that links to the one in this repo if we move it, but it would make the contribution experience on github worse (more clicks to figure out what is what)

it's probably better to ignore importing these, and ensure they either don't link to sibling docs (so it's embedded better on the website), or link to them in a way we can fixup after importing.

probably impossible to move

  • CHANGELOG (from kube-rs) - needs to be generated in that repo
  • getting-started (hacked from README in kube-rs) - might be better to rewrite?

the changelog is fine. it's meant to be an import dump, but maybe it's worth rethinking the readme anyway.

care

doing this would break some links from markdown docs in other repos, and also break best practice docs links in the best practice badge, but should be easy to fix.

possibly some cncf-wide links need to be changed upstream, need to revisit the upstream donation issue to verify these files are not linked to directly. think possibly governance is linked somewhere.

benefits

  • allows enabling edit button for ez website contribution
  • limit pr mistakes from people editing website and not seeing the warning header
  • allows unmovable docs to link to the website for users to get a better overview

i think we should import the easy stuff, and then improve the rest iteratively as we go.

@clux clux changed the title import most repo-wide files into this repo import most vendored files into this repo Mar 7, 2022
clux added a commit to kube-rs/kube that referenced this issue Apr 2, 2022
clux added a commit to kube-rs/.github that referenced this issue Apr 2, 2022
clux added a commit that referenced this issue Apr 2, 2022
clux added a commit to kube-rs/.github that referenced this issue Apr 2, 2022
@clux clux self-assigned this Apr 2, 2022
@clux clux linked a pull request Apr 2, 2022 that will close this issue
@clux clux closed this as completed in #16 Apr 3, 2022
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 a pull request may close this issue.

1 participant