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

📖 Refactor documentation sections and mention Helm chart #3113

Merged
merged 6 commits into from
Apr 8, 2024

Conversation

embik
Copy link
Member

@embik embik commented Apr 5, 2024

Summary

This PR takes a stab at reworking the structure of our documentation to clearly split topic and help people find the right information depending on their own context.

The following top-level sections exist now:

  • Home - landing page and goals, extracted the quickstart out of this.
  • Setup - this is new and gathers all the various ways and tools for kcp setups. The quickstart and kubectl plugin setup has been moved here, but a short page referencing the Helm chart has also been added.
  • Concepts - this mostly stayed the same in purpose, but subsections have been added to give the whole section more structure.
  • Developers - this section now mostly targets developers that want to develop against kcp, e.g. writing their own controllers.
  • Contributing - new section that holds the existing "CONTRIBUTING.md" content and also gathers everything related to developing (i.e. contributing to) kcp.
  • Reference - no changes here except for some index pages.

Overall, I've mostly shifted around content (sometimes whole files, sometimes parts of a longer document) to accommodate the new structure. Here and there I've also updated content (e.g. the quickstart doesn't need a kind cluster; this was probably a leftover from trying out TMC with it).

Related issue(s)

Fixes #

Release Notes

NONE

@kcp-ci-bot kcp-ci-bot added release-note-none Denotes a PR that doesn't merit a release note. dco-signoff: yes Indicates the PR's author has signed the DCO. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Apr 5, 2024
@embik embik changed the title 📖 Refactor documentation sections and add Helm chart installation method 📖 Refactor documentation sections and mention Helm chart Apr 5, 2024
@embik
Copy link
Member Author

embik commented Apr 8, 2024

/cc @xrstf @sttts @mjudeikis

@kcp-ci-bot kcp-ci-bot requested review from mjudeikis, sttts and xrstf April 8, 2024 07:44
@mjudeikis
Copy link
Contributor

/lgtm
/approve
/hold

@kcp-ci-bot kcp-ci-bot added do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. lgtm Indicates that a PR is ready to be merged. labels Apr 8, 2024
@kcp-ci-bot
Copy link
Contributor

LGTM label has been added.

Git tree hash: a11e307a7093334ea50c4e4a2f76e768f9e38370

@kcp-ci-bot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: mjudeikis

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@kcp-ci-bot kcp-ci-bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Apr 8, 2024
@mjudeikis
Copy link
Contributor

I think we can iterate ontop if something is off

@embik
Copy link
Member Author

embik commented Apr 8, 2024

I think we can iterate ontop if something is off

That's the idea. It deploys to https://docs.kcp.io/kcp/main anyway, not to the "stable" docs. Who/when would you like to lift the hold? After a second review?

@xrstf
Copy link
Contributor

xrstf commented Apr 8, 2024

/hold cancel

@kcp-ci-bot kcp-ci-bot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Apr 8, 2024
@kcp-ci-bot kcp-ci-bot merged commit 440aab9 into kcp-dev:main Apr 8, 2024
15 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. dco-signoff: yes Indicates the PR's author has signed the DCO. lgtm Indicates that a PR is ready to be merged. release-note-none Denotes a PR that doesn't merit a release note. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants