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

[TASK] Improve wording and add some additions to migration #407

Merged
merged 12 commits into from
Apr 17, 2024

Conversation

Alagts
Copy link
Contributor

@Alagts Alagts commented Apr 16, 2024

No description provided.

@Alagts Alagts requested a review from linawolf April 16, 2024 12:26
Documentation/Migration/Index.rst Outdated Show resolved Hide resolved
Documentation/Migration/Index.rst Outdated Show resolved Hide resolved
Documentation/Migration/Index.rst Outdated Show resolved Hide resolved
Documentation/Migration/Index.rst Outdated Show resolved Hide resolved
Documentation/Migration/Index.rst Outdated Show resolved Hide resolved
Documentation/Migration/Index.rst Outdated Show resolved Hide resolved
Documentation/Migration/Index.rst Show resolved Hide resolved
Documentation/Migration/Index.rst Outdated Show resolved Hide resolved
Documentation/Migration/Index.rst Outdated Show resolved Hide resolved
Documentation/Migration/Index.rst Outdated Show resolved Hide resolved
@garvinhicking
Copy link
Contributor

Hi @Alagts !

These are some cool improvements, thank you for taking the time and working on this. It is important to streamline this for both newcomers and existing users of our documentation workflow and get it right.👏👏👏

Copy link
Contributor

@brotkrueml brotkrueml left a comment

Choose a reason for hiding this comment

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

Regarding the warning examples: I suggest to add a paragraph, like

Problem: anchor not found

or

Problem: manual with given version not found

directly after the heading. I have to read the whole section to get what is wrong. This short introduction eases the understanding of the problem.

Documentation/Migration/Index.rst Outdated Show resolved Hide resolved
Documentation/Migration/Index.rst Outdated Show resolved Hide resolved
Documentation/Migration/Index.rst Outdated Show resolved Hide resolved
Documentation/Migration/Index.rst Outdated Show resolved Hide resolved
Documentation/Migration/Index.rst Outdated Show resolved Hide resolved
Documentation/Migration/Index.rst Show resolved Hide resolved
Documentation/Migration/Index.rst Show resolved Hide resolved
Documentation/Migration/Index.rst Outdated Show resolved Hide resolved
Documentation/Migration/Index.rst Outdated Show resolved Hide resolved
Documentation/Migration/Index.rst Outdated Show resolved Hide resolved
@linawolf linawolf requested a review from brotkrueml April 17, 2024 10:09
@linawolf
Copy link
Member

@brotkrueml please let us get this merged. You are welcome to further improve this section in a follow up

@brotkrueml
Copy link
Contributor

@brotkrueml please let us get this merged. You are welcome to further improve this section in a follow up

I am not blocking it. Feel free to approve and merge, I won't approve it for now.

@linawolf linawolf dismissed brotkrueml’s stale review April 17, 2024 16:15

"I am not blocking it."

Copy link
Member

@linawolf linawolf left a comment

Choose a reason for hiding this comment

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

Thanks a lot for these great changes

@linawolf linawolf merged commit 176d065 into documentation-draft Apr 17, 2024
2 checks passed
@linawolf linawolf deleted the alagts/migration-improvement branch April 17, 2024 16:53
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 this pull request may close these issues.

4 participants