search

GoogleCloudPlatform / cloud-ops-sandbox

Cloud Operations Sandbox is an open source collection of tools that helps practitioners to learn O11y and R9y practices from Google and apply them using Cloud Operations suite of tools.
Apache License 2.0
406 stars 148 forks source link

Reduce # of pages in NEOS tutorial #779

Closed simonz130 closed 2 years ago

simonz130 commented 3 years ago

Currently (as of 0.7.0) NEOS tutorial that is opening up next to Cloud Shell window has 9 pages. 6 of them look similar but shorter versions of what's available in the user guide. We want to shorten the NEOS tutorial and move details into the user guide. (Hugo static website under /website folder)

simonz130 commented 3 years ago

This is good ticket to take for folks who are getting started with Sandbox as contributors.

simonz130 commented 3 years ago

@daniel-sanche could you please re-assign to one of the new contributors?

napster-satyam commented 3 years ago

Is the Issue still open @simonz130 ?

minherz commented 2 years ago

Reading through NEOS tutorial it looks like the content requires a rewrite. The text is poorly fit to the width of the NEOS tutorial window and the use of the formatting options is bad. For example, the code option that shows the output of the automated deployment is displayed in the tutorial as a command ready for execution in Cloud Shell. A lot of content should be replaced with a single link to the User Guide (on cloud-ops-sandbox.dev).

I replace this issue with a new one that will request to revise all documentation and tutorials toward the upcoming changes.