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

[Maintenance] Remove obsolete docs, restructure for better UX - GT-314 #1447

Merged
merged 1 commit into from
Oct 19, 2023

Conversation

nikita-vanyasin
Copy link
Contributor

@nikita-vanyasin nikita-vanyasin commented Oct 18, 2023

  • move docs/design/features to docs/features for better structure
  • add generator for features index (docs/features/README.md)
  • add generator for API reference index (docs/api/README.md)
  • remove obsolete docs
  • update old docs with new information (e.g. there is ArangoDeployment.Status.State field anymore)
  • move guides from design to how-to section

Check result here: https://github.com/arangodb/kube-arangodb/tree/6d452c07f33bbc61d3fe753602b8d7db43d1ac80/docs

In next PRs we are going to move docs from main documentation website to this repo.

- move docs/design/features to docs/features for
- add generator for features index (docs/features/README.md)
- add generator for API reference index (docs/api/README.md)
- remove obsolete docs
- update old docs with new information (e.g. there is ArangoDeployment.Status.State field anymore)
- move guides from `design` to `how-to` section
@nikita-vanyasin nikita-vanyasin requested a review from a team as a code owner October 18, 2023 08:26
@cla-bot cla-bot bot added the cla-signed label Oct 18, 2023
@nikita-vanyasin nikita-vanyasin changed the title Remove obsolete docs, restructure for better UX [Maintenance] Remove obsolete docs, restructure for better UX - GT-314 Oct 18, 2023
docs/design/maintenance.md Show resolved Hide resolved
docs/bare-metal.md Show resolved Hide resolved
@jwierzbo jwierzbo merged commit 6f6fcb8 into master Oct 19, 2023
3 checks passed
@jwierzbo jwierzbo deleted the update-and-restructure-docs branch October 19, 2023 07:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants