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: Reduce landscape setup in tutorial #822

Merged
merged 6 commits into from
Jul 1, 2024

Conversation

edibotopic
Copy link
Collaborator

@edibotopic edibotopic commented Jul 1, 2024

This PR makes the tutorial shorter and more generic by reducing the emphasis on Landscape setup.

The material on Landscape server setup in WSL is moved to a separate how-to.

Screenshots of UI elements were changed to ensure they are up-to-date and in English.

Minor additional changes were made to improve agreement with style guide.

UDENG-3054

@edibotopic edibotopic requested a review from a team as a code owner July 1, 2024 08:27
@edibotopic edibotopic changed the title Reduce landscape setup in tutorial docs: Reduce landscape setup in tutorial Jul 1, 2024
Copy link
Contributor

@jibel jibel left a comment

Choose a reason for hiding this comment

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

Looks fine to me. Two small comments, though.

docs/tutorial/index.md Outdated Show resolved Hide resolved
docs/tutorial/index.md Show resolved Hide resolved
Copy link
Contributor

@jibel jibel left a comment

Choose a reason for hiding this comment

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

All good! Thank you!

@edibotopic edibotopic merged commit 9633ba6 into main Jul 1, 2024
3 checks passed
@edibotopic edibotopic deleted the reduce-landscape-setup-in-tutorial branch July 1, 2024 12:30
@edibotopic
Copy link
Collaborator Author

Thanks as always @jibel !!!

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.

Looks like I arrived late ;)

# How to install Landscape server in a WSL instance

While a Landscape server typically runs on external computers, here it will be
set up on a WSL instance on a Windows machine.
Copy link
Contributor

Choose a reason for hiding this comment

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

If we'd preserve this piece I think it'd be good to present a motivation for doing so, as hosting Landscape on a WSL instance is not a supported way per se. In my view, the motivation is to ease development and testing of UP4W for those who don't have another machine to host Landscape and find setting up VMs harder than trying to run it on WSL, thus I'd place this under dev docs

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I think that's a great idea @CarlosNihelton and this should definitely be considered in a future revision.

For this PR I just wanted to make sure the useful information was captured somewhere so that it did not get lost. It was an "extra" after the material had been removed from the main tutorial.

I will note your suggestions down for now. Providing a more explicit motivation should be done wherever this guide is ultimately located.

Whether it should be in dev docs is something I/we need to think about. This depends to an extent on what we think about the state of those dev docs, their organisation as a whole and where they will fit in the WSL docs.

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