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: merge wsl docs repos #1044

Merged
merged 13 commits into from
Jan 20, 2025
Merged

docs: merge wsl docs repos #1044

merged 13 commits into from
Jan 20, 2025

Conversation

edibotopic
Copy link
Collaborator

@edibotopic edibotopic commented Jan 9, 2025

This merges the docs from the Ubuntu WSL repo to the Ubuntu Pro for WSL repo.
Ultimately, this is with a view to presenting both sets of content on a single documentation website.

Specific changes include:

  • moves doc pages and custom configs from Ubuntu WSL repo to UP4W repo
  • reorganises docs to better include and surface content from both repos
  • rewrites homepage to make more appropriate for distro and app
  • adds a Pro feature notice to relevant pages
  • lightly rewrites VSCode guide as more generic starter tutorial (to be developed further with community)
  • adds redirects for old Ubuntu WSL docs site URLs
  • various fixes and touch-ups

After this PR is merged, the UP4W documentation site will be updated with the new content, as normal.
Next, the source repo for the Ubuntu WSL site will be switched to the UP4W repo.
For a while, both sites will have the same content before eventually the ubuntu-wsl URL will become the default.

UDENG-5640

@edibotopic edibotopic marked this pull request as ready for review January 9, 2025 11:29
@edibotopic edibotopic requested a review from a team as a code owner January 9, 2025 11:29
Copy link
Contributor

@CarlosNihelton CarlosNihelton left a comment

Choose a reason for hiding this comment

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

I think you found a very sensible way to tackle this task. I have some ideas for your consideration, but nothing major.

docs/custom_conf.py Show resolved Hide resolved
docs/reference/distributions.md Outdated Show resolved Hide resolved
docs/howto/install-ubuntu-wsl2.md Outdated Show resolved Hide resolved
docs/tutorial/develop-with-ubuntu-wsl.md Outdated Show resolved Hide resolved
docs/tutorial/develop-with-ubuntu-wsl.md Outdated Show resolved Hide resolved
docs/tutorial/getting-started.md Outdated Show resolved Hide resolved
docs/tutorial/getting-started.md Outdated Show resolved Hide resolved
docs/howto/cloud-init.md Outdated Show resolved Hide resolved
docs/howto/data-science-and-engineering.md Outdated Show resolved Hide resolved
@edibotopic
Copy link
Collaborator Author

I think you found a very sensible way to tackle this task. I have some ideas for your consideration, but nothing major.

Thanks a lot @CarlosNihelton -- really useful comments and suggestions as usual.

* moves doc pages to UP4W repo
* reorganise docs to include content from both repos
* rewrite homepage to make more generic
* add a Pro feature notice in relevant pages
* light rewrite of VSCode guide as starter tutorial
* various fixes and touch-ups
this makes the url more descriptive
Don't use "store" in context where MS Store might be assumed.
@edibotopic edibotopic force-pushed the merge-wsl-docs-repos branch from c0cdcc3 to 1c2d28a Compare January 20, 2025 11:47
@edibotopic
Copy link
Collaborator Author

@CarlosNihelton -- I've addressed all your comments and also:

  • Added product page and matrix links to the docs site
  • Gave the UP4W tutorial a more descriptive url (/getting-started -> /getting-started-with-up4w) and added a redirect

Copy link
Contributor

@CarlosNihelton CarlosNihelton left a comment

Choose a reason for hiding this comment

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

Great job as usual!

@edibotopic edibotopic merged commit 67cf92c into main Jan 20, 2025
3 checks passed
@edibotopic edibotopic deleted the merge-wsl-docs-repos branch January 20, 2025 13:23
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.

2 participants