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

cloud-docs rst->md conversion #55

Merged
merged 9 commits into from
Mar 7, 2024
Merged

Conversation

matkuliak
Copy link
Contributor

@matkuliak matkuliak commented Mar 4, 2024

What's Inside

Significant changes.

Preview

https://crate-cloud--55.org.readthedocs.build/en/55/

Highlights

  • howtos - rst->md

    • reworked index to use the grid layout, added cards
    • deleted howtos/connect-to-cluster/index.md and placed the card within it directly into index.md
    • added a reference point to tutorials/quickstart
  • tutorials/edge

    • converted rst->md
    • reworked index, added the cards similar to others
  • reference - rst->md

  • tutorials/deploy/croud.md - rst->md

    • added a card to cannonical croud docs to make them more prominent

Checklist

@matkuliak matkuliak added the documentation Improvements or additions to documentation label Mar 4, 2024
@matkuliak
Copy link
Contributor Author

matkuliak commented Mar 4, 2024

Went through all the changes pretty rigorously multiple times, but it's a big change so would appreciate a review from anyone interested. Thank you in advance.

The main concern is broken links/references, although checks should catch those. Technically everything should work, quite sure of that.

@matkuliak matkuliak requested review from proddata and amotl and removed request for proddata March 4, 2024 02:58

::::

## Cluster Management
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
## Cluster Management
:::
## Cluster Management
:::

Copy link
Member

Choose a reason for hiding this comment

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

wrapping them doesn't show them in the toc

Co-authored-by: Georg Traar <proddata@users.noreply.github.com>
Copy link
Member

@amotl amotl left a comment

Choose a reason for hiding this comment

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

Hi. That's a huge amount of work which went into this patch, thank you very much! 💯

Currently, I don't have the capacity to review it completely, roughly about 4,000 lines being changed, so please either wait for another cycle (one day or two), or just merge when you need it, and when there are no other objections. I've just added a few suggestions while quickly navigating into the patch, nothing serious.

docs/howtos/add-users.md Show resolved Hide resolved
docs/howtos/add-users.md Outdated Show resolved Hide resolved
docs/howtos/add-users.md Show resolved Hide resolved
docs/howtos/add-users.md Outdated Show resolved Hide resolved
docs/howtos/create-org.md Outdated Show resolved Hide resolved
docs/tutorials/deploy/croud.md Outdated Show resolved Hide resolved
docs/tutorials/deploy/croud.md Outdated Show resolved Hide resolved
docs/tutorials/deploy/croud.md Outdated Show resolved Hide resolved
````{note}
Complete documentation on clusters in Croud, including all the
deployment arguments, can be found
[here](https://crate.io/docs/cloud/cli/en/latest/commands/clusters.html).
Copy link
Member

Choose a reason for hiding this comment

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

Maybe it also works like this to refer to a doc label? I didn't try, yet. If it works, it would also be a good candidate to expand the authoring guide about referencing correspondingly.

Suggested change
[here](https://crate.io/docs/cloud/cli/en/latest/commands/clusters.html).
[here](inv:croud#commands/clusters).

Copy link
Member

@amotl amotl Mar 4, 2024

Choose a reason for hiding this comment

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

Also added a note about this where to improve the authoring guidelines.

-- crate/crate-docs-theme#472 (comment)

docs/tutorials/deploy/croud.md Outdated Show resolved Hide resolved
Co-authored-by: Andreas Motl <andreas.motl@crate.io>
docs/reference/overview.md Show resolved Hide resolved
docs/tutorials/edge/monitoring.md Show resolved Hide resolved
@amotl amotl mentioned this pull request Mar 6, 2024
2 tasks
@matkuliak
Copy link
Contributor Author

matkuliak commented Mar 7, 2024

Hi @amotl. Do you still need couple more days to look this over, or are you happy with it?
I've got some feature docs in-progress and would like to merge this first and do them in Markdown already. Not to rush you, of course. Thanks!

@amotl
Copy link
Member

amotl commented Mar 7, 2024

Hi Matej. I can't find the cycles, unfortunately. I think it will be good to go, please go ahead. Thanks again!

@matkuliak matkuliak merged commit 1c78a28 into main Mar 7, 2024
3 checks passed
@matkuliak matkuliak deleted the mm/rst-to-markdown-conversion branch March 7, 2024 16:39
This was referenced Mar 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants