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

Docs: simplify "Add project" page #11559

Merged
merged 6 commits into from
Sep 12, 2024
Merged

Docs: simplify "Add project" page #11559

merged 6 commits into from
Sep 12, 2024

Conversation

humitos
Copy link
Member

@humitos humitos commented Aug 21, 2024

  • Rename it to add-project.html
  • Always use "add" instead of "import"
  • Explain the process using the new dashboard
  • Make usage of a numbered list of steps intead of a single paragraph
  • Remove irrelevant content and focus on adding a project
  • Keep relevant links under "See also" sections

📚 Documentation previews 📚 https://docs--11559.org.readthedocs.build/en/11559/intro/add-project.html

* Rename it to `add-project.html`
* Always use "add" instead of "import"
* Explain the process using the new dashboard
* Make usage of a numbered list of steps intead of a single paragraph
* Remove irrelevant content and focus on _adding a project_
* Keep relevant links under "See also" sections
@humitos humitos requested a review from a team as a code owner August 21, 2024 15:49
@humitos humitos requested a review from agjohnson August 21, 2024 15:49
Copy link
Member

@ericholscher ericholscher left a comment

Choose a reason for hiding this comment

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

Simple enough 👍

docs/user/guides/setup/git-repo-automatic.rst Outdated Show resolved Hide resolved
docs/user/intro/add-project.rst Outdated Show resolved Hide resolved
docs/user/intro/add-project.rst Outdated Show resolved Hide resolved
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.

With the updated content on the adding a project page, we should avoid using the term importing a project and similar while we link to the new page. I've noted some instances that were missed.

docs/user/glossary.rst Outdated Show resolved Hide resolved
docs/user/guides/setup/git-repo-automatic.rst Outdated Show resolved Hide resolved
Comment on lines 39 to 42
Once you have added the first project from the :ref:`Import Wizard <intro/add-project:Automatically add your project>`,
it will show as if it has already been imported and cannot be imported again.
In order to add another project with the same repository,
you will need to use the :ref:`Manual Import <intro/import-guide:Manually import your docs>`.
you will need to use the :ref:`Manual Import <intro/add-project:Manually add your project>`.
Copy link
Contributor

Choose a reason for hiding this comment

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

I would update both of these to use "create"/"add"/etc instead of import, the docs they are pointing to don't use import.

Copy link
Member Author

Choose a reason for hiding this comment

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

Actually, this sentence needs to be updated since this limitation is removed.

docs/user/intro/add-project.rst Outdated Show resolved Hide resolved
docs/user/intro/add-project.rst Outdated Show resolved Hide resolved
docs/user/intro/getting-started-with-mkdocs.rst Outdated Show resolved Hide resolved
docs/user/intro/getting-started-with-sphinx.rst Outdated Show resolved Hide resolved
humitos and others added 2 commits September 12, 2024 14:08
Co-authored-by: Anthony <aj@ohess.org>
Co-authored-by: Eric Holscher <25510+ericholscher@users.noreply.github.com>
@humitos humitos enabled auto-merge (squash) September 12, 2024 12:12
@humitos
Copy link
Member Author

humitos commented Sep 12, 2024

Tests errors are un-related.

@humitos humitos merged commit bc847f9 into main Sep 12, 2024
3 of 5 checks passed
@humitos humitos deleted the humitos/docs-add-project branch September 12, 2024 12:22
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.

3 participants