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

feat(docs): add Setup Quickstart tutorial #308

Merged
merged 9 commits into from
Jan 27, 2022
Merged

feat(docs): add Setup Quickstart tutorial #308

merged 9 commits into from
Jan 27, 2022

Conversation

kelsk
Copy link
Contributor

@kelsk kelsk commented Jan 21, 2022

Add setup-quickstart.md which contains instructions on deploying Emblem using the setup script.

Add setup-walkthrough.md which contains similar instructions configured to run as a Neos interactive walkthrough tutorial. (Test the walkthrough using this link: Open in Cloud Shell)


Limitations

The tutorials do not include detailed Next steps. This should not be a blocker for adding the initial tutorials, but adding detailed next steps should be a priority in the short term.

@kelsk kelsk added type: docs Improvement to the documentation for an API. component: demo services Related to interactive learning using the app. labels Jan 21, 2022
@kelsk kelsk requested a review from a team as a code owner January 21, 2022 20:47
## Introduction

In this tutorial, you'll set up the Emblem application by following these steps:
1. run a script to deploy Emblem to [Cloud Run](https://cloud.google.com/run)
Copy link
Contributor

Choose a reason for hiding this comment

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

Nit: capitalize these?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Nit accepted ✅

@kelsk kelsk requested a review from ace-n January 24, 2022 19:17
Copy link
Contributor

@ace-n ace-n 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 forgot to push an updated version of setup-walkthrough.md?

Other than that (and a few other nits), LGTM. 🙂

kelsk and others added 4 commits January 27, 2022 14:16
Co-authored-by: Ace Nassri <anassri@google.com>
Co-authored-by: Ace Nassri <anassri@google.com>
Co-authored-by: Ace Nassri <anassri@google.com>
@kelsk
Copy link
Contributor Author

kelsk commented Jan 27, 2022

@ace-n Thank you! Yep, I forgot to push the changes up 😅 setup-walkthrough is now updated ✅

@kelsk kelsk merged commit 8a85c1a into main Jan 27, 2022
@pattishin pattishin deleted the quickstart-tutorial branch December 9, 2022 21:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component: demo services Related to interactive learning using the app. type: docs Improvement to the documentation for an API.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants