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

Tighten up and refactor the tutorial WIP #11316

Merged
merged 13 commits into from
May 23, 2024
Merged

Tighten up and refactor the tutorial WIP #11316

merged 13 commits into from
May 23, 2024

Conversation

plaindocs
Copy link
Contributor

@plaindocs plaindocs commented May 8, 2024

No major changes. Edits intended to

  • simplify
  • make more consistent
  • streamline some instructions

📚 Documentation previews 📚

@plaindocs plaindocs requested a review from a team as a code owner May 8, 2024 15:23
@plaindocs plaindocs requested a review from agjohnson May 8, 2024 15:23
Copy link
Contributor

@agjohnson agjohnson left a comment

Choose a reason for hiding this comment

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

Thanks for the clean up here, this is a great improvement!

I noted "import" vs "create" when referring to project creation. There is a longer conversation here:

It's not immediately necessary to be updating this verbiage, but perhaps instead we chip away where we can.

This is related to a larger update looming here, when we update our docs to use our new dashboard for instructions and UI screenshots. But again, not much we can do here immediately and we haven't talked about how we want to manage updating our docs.

docs/user/tutorial/index.rst Show resolved Hide resolved
docs/user/tutorial/index.rst Outdated Show resolved Hide resolved
docs/user/tutorial/index.rst Outdated Show resolved Hide resolved
docs/user/tutorial/index.rst Outdated Show resolved Hide resolved
docs/user/tutorial/index.rst Show resolved Hide resolved
docs/user/tutorial/index.rst Outdated Show resolved Hide resolved
docs/user/tutorial/index.rst Outdated Show resolved Hide resolved
docs/user/tutorial/index.rst Outdated Show resolved Hide resolved
docs/user/tutorial/index.rst Outdated Show resolved Hide resolved
docs/user/tutorial/index.rst Outdated Show resolved Hide resolved
@plaindocs
Copy link
Contributor Author

I noted "import" vs "create" when referring to project creation. There is a longer conversation here:

* [Change copy around "import project" #7280](https://github.com/readthedocs/readthedocs.org/issues/7280)

This is related to a larger update looming here, when we update our docs to use our new dashboard for instructions and UI screenshots. But again, not much we can do here immediately and we haven't talked about how we want to manage updating our docs.

This is great to know about, thanks.

Copy link
Contributor

@agjohnson agjohnson left a comment

Choose a reason for hiding this comment

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

These changes all look great, I only have minor notes on the changes.

docs/user/tutorial/index.rst Outdated Show resolved Hide resolved
docs/user/tutorial/index.rst Show resolved Hide resolved
docs/user/tutorial/index.rst Show resolved Hide resolved
docs/user/tutorial/index.rst Outdated Show resolved Hide resolved
docs/user/tutorial/index.rst Show resolved Hide resolved
docs/user/tutorial/index.rst Show resolved Hide resolved
@plaindocs plaindocs enabled auto-merge (squash) May 23, 2024 15:31
@plaindocs plaindocs merged commit 964926c into main May 23, 2024
4 checks passed
@plaindocs plaindocs deleted the sam/tutorial branch May 23, 2024 15:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

None yet

2 participants