Skip to content

Docs: Refactor "Importing your documentation" #10383

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

Closed
benjaoming opened this issue Jun 5, 2023 · 2 comments
Closed

Docs: Refactor "Importing your documentation" #10383

benjaoming opened this issue Jun 5, 2023 · 2 comments
Labels
Needed: documentation Documentation is required

Comments

@benjaoming
Copy link
Contributor

benjaoming commented Jun 5, 2023

Currently, Importing your documentation is nested in the Tutorials section.

But it's not really a tutorial.

The current content will mislead a user looking for an easy tutorial. For the fast reader, the page might also wrongly convey only the manual method since the automatic method is easy to miss.

I would propose:

  1. Create a how-to from the manual parts: "How to import a Git repository manually" ✔️
  2. Create a feature reference about Automatic Import of Git repositories ✔️
  3. Update the current Getting Started tutorial with references to these.
  4. Redirect the old page to the new feature reference
@benjaoming benjaoming added the Needed: documentation Documentation is required label Jun 5, 2023
@github-project-automation github-project-automation bot moved this to Planned in 📍Roadmap Jun 5, 2023
@benjaoming
Copy link
Contributor Author

Update: The first 2 items are now satisfied by new pages that were added recently so this should be much easier to implement.

@humitos
Copy link
Member

humitos commented Sep 15, 2023

This seems done already. We are linking to the manual import guide from getting started now.

@humitos humitos closed this as completed Sep 15, 2023
@github-project-automation github-project-automation bot moved this from Planned to Done in 📍Roadmap Sep 15, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Needed: documentation Documentation is required
Projects
Archived in project
Development

No branches or pull requests

2 participants