[docs] Restructure how-to section to make it more readable #3147

wjayesh · 2024-10-28T09:22:47Z

Describe changes

I restructured the existing how-to section based on this idea: https://www.notion.so/zenml/Restructure-how-to-section-after-we-write-all-other-docs-to-make-it-easier-to-read-11ff8dff253880e9883bcd9567131689
Added redirects so older links point to new locations

Pre-requisites

Please ensure you have done the following:

I have read the CONTRIBUTING.md document.
If my change requires a change to docs, I have updated the documentation accordingly.
I have added tests to cover my changes.
I have based my new branch on develop and the open PR is targeting develop. If your branch wasn't based on develop read Contribution guide on rebasing branch to develop.
If my changes require changes to the dashboard, these changes are communicated/requested.

Types of changes

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to change)
Other (add details above)

coderabbitai · 2024-10-28T09:22:54Z

Important

Review skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

htahir1

You moved all these but did not change the links within the content! :-D

htahir1 · 2024-10-28T09:26:44Z

.gitbook.yaml

+  how-to/use-the-model-control-plane/README.md: how-to/model-management-metrics/model-control-plane/README.md
+  how-to/use-the-model-control-plane/register-a-model.md: how-to/model-management-metrics/model-control-plane/register-a-model.md
+  how-to/use-the-model-control-plane/delete-a-model.md: how-to/model-management-metrics/model-control-plane/delete-a-model.md
+  how-to/use-the-model-control-plane/associate-a-pipeline-with-a-model.md: how-to/model-management-metrics/model-control-plane/associate-a-pipeline-with-a-model.md
+  how-to/use-the-model-control-plane/connecting-artifacts-via-a-model.md: how-to/model-management-metrics/model-control-plane/connecting-artifacts-via-a-model.md
+  how-to/use-the-model-control-plane/model-versions.md: how-to/model-management-metrics/model-control-plane/model-versions.md


left side should not end in .md

yes, fixing it!

wjayesh · 2024-10-28T09:39:35Z

@htahir1 we don't need to change the links in all files, that's what the redirects help with, correct? Just verified that links in pages that point to the moved docs still work. For example, check out the this docs page link in the deployed docs https://app.gitbook.com/o/-MCl1Hlw9oU4xibZ-ymf/s/-MCl0MaN3pJfPa2vq2Rb/~/revisions/79v2nDlm4bhHjIxCY4h5/stack-components/orchestrators/airflow#additional-configuration

htahir1 · 2024-10-28T10:03:12Z

@wjayesh i know but isnt it weird to have intentionally broken links? can we just change these to point to the right paths please?

htahir1

one small thing but totherwise looks good to go

htahir1 · 2024-10-28T14:51:03Z

.gitbook.yaml

+  how-to/build-pipelines/name-your-pipeline-and-runs: how-to/pipeline-development/build-pipelines/name-your-pipeline-runs.md
+
+  # Project Setup redirects
+  how-to/setting-up-a-project-repository/README: how-to/project-setup-and-management/setting-up-a-project-repository/README.md


https://docs.zenml.io/how-to/setting-up-a-project-repository/README is not a real link. These README ones resolve to https://docs.zenml.io/how-to/setting-up-a-project-repository/ without the README

Please update for all the rest

ah, i see. let me update it

ok done and tested for all README files

htahir1 · 2024-10-28T15:02:24Z

docs/book/how-to/advanced-topics/manage-zenml-server/best-practices-upgrading-zenml.md

@@ -67,7 +67,7 @@ loaded_artifact = artifact.load()
 While ZenML strives for backward compatibility, be prepared for occasional breaking changes (e.g., [the Pydantic 2 upgrade](https://github.com/zenml-io/zenml/releases/tag/0.60.0)).

 - **Changelog Review**: Always review the [changelog from new releases](https://github.com/zenml-io/zenml/releases) for new syntax, instructions, or breaking changes.
- **Migration Scripts**: Use provided [migration scripts](../../how-to/manage-the-zenml-server/migration-guide/migration-guide.md) when available to handle database schema changes.
+- **Migration Scripts**: Use provided [migration scripts](migration-guide/migration-guide.md) when available to handle database schema changes.


is this correct?

yes, the migration guide is in the same directory and resolves to the right file

wjayesh added 4 commits October 28, 2024 13:28

restructure how-to section

5965e9d

set up redirects

2b45313

Merge branch 'develop' into docs/restructure-how-to

2754b99

fix redirects

7c26688

htahir1 requested changes Oct 28, 2024

View reviewed changes

fix redirects

5f7d764

wjayesh requested a review from htahir1 October 28, 2024 09:51

wjayesh added 19 commits October 28, 2024 16:30

add missing file from merge

50f446b

fix some links

1a780ef

fix broken links

ea13d81

add more redirects

6380e73

fix more links

cd6642f

modify redirect from michael's pr

3e2ae90

Merge branch 'develop' into docs/restructure-how-to

61e67fd

check if prob is with new redirects

468f3cb

let's narrow the prob down

7fad59b

let's narrow the prob down

81441b7

let's narrow the prob down

28b9373

fix a link

986a6ab

let's narrow the prob down

5068317

check if bad paths lead to error

9f65b79

rm duplicate entry

78a6d69

add new icons

849fd72

fix the readme files

60dfb13

try without slash

c501fae

try

713848e

htahir1 requested changes Oct 28, 2024

View reviewed changes

try

651afd3

wjayesh requested a review from htahir1 October 28, 2024 17:08

htahir1 approved these changes Oct 28, 2024

View reviewed changes

htahir1 merged commit 0c2ebc4 into develop Oct 28, 2024
10 checks passed

htahir1 deleted the docs/restructure-how-to branch October 28, 2024 22:02

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[docs] Restructure how-to section to make it more readable #3147

[docs] Restructure how-to section to make it more readable #3147

wjayesh commented Oct 28, 2024

coderabbitai bot commented Oct 28, 2024

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

htahir1 left a comment

htahir1 Oct 28, 2024

wjayesh Oct 28, 2024

wjayesh commented Oct 28, 2024

htahir1 commented Oct 28, 2024

htahir1 left a comment

htahir1 Oct 28, 2024

htahir1 Oct 28, 2024

wjayesh Oct 28, 2024

wjayesh Oct 28, 2024

htahir1 Oct 28, 2024

wjayesh Oct 28, 2024

[docs] Restructure how-to section to make it more readable #3147

[docs] Restructure how-to section to make it more readable #3147

Conversation

wjayesh commented Oct 28, 2024

Describe changes

Pre-requisites

Types of changes

coderabbitai bot commented Oct 28, 2024

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

htahir1 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

wjayesh commented Oct 28, 2024

htahir1 commented Oct 28, 2024

htahir1 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment