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
Update getting started guide, migrate create new app guide, and rearrange nav (next gen) #1603
Update getting started guide, migrate create new app guide, and rearrange nav (next gen) #1603
Conversation
Codecov Report
@@ Coverage Diff @@
## main #1603 +/- ##
=======================================
Coverage 82.01% 82.01%
=======================================
Files 18 18
Lines 1496 1496
Branches 436 436
=======================================
Hits 1227 1227
Misses 172 172
Partials 97 97 📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
@ashleymcm @stevengill - These refinements look good to me! Thoughts on relocating the entire section to above Basic concepts in a future PR so that it's a bit more "above the fold"? |
380bb4d
to
80e81c1
Compare
I like the idea to make it higher visibility! 👍 One thought is, would it be confusing to put it as the first heading under "Getting Started" and "Reference" since the Getting Started guide still covers the non next-gen concepts and it's listed at the top? @srajiang @stevengill |
Merging this in! In a following PR, I will focus on standardizing examples across functions, triggers, and workflows pages to focus on the Hello World example so it is more coherent. That PR may also contain a separate page on interactivity. We may also add in the update mentioned above with rearranging the nav depending on the decision made there! ✅ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Love it! Big improvements
|
||
With your app running, access your workspace and paste the URL from the the Trigger you created in the previous step into a message in a public channel. | ||
|
||
> 💡 To make the trigger URL more widely accessible, we recommend saving the Trigger as a channel bookmark for easy access. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
So it gets auto saved in the workflows
directory in the bookmarks bar now. We should update this message to reflect that
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Will do! I started the branch for additional updates, so added that in there!
Personally, i'd keep this getting started guide where it is for now. We can discuss moving it more top level closer to GA |
Summary
The goal of this PR is to achieve the following docs updates:
In a following PR, I will focus on standardizing examples across functions, triggers, and workflows pages to focus on the Hello World example so it is more coherent. That PR may also contain a separate page on interactivity.
Requirements (place an
x
in each[ ]
)