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

New tutorials with wadm, additional context for our benefits #112

Merged
merged 2 commits into from Jul 20, 2023

Conversation

brooksmtownsend
Copy link
Member

@brooksmtownsend brooksmtownsend commented Jun 14, 2023

Feature or Problem

With the latest additions to wash, wadm, and wasmCloud, our documentation could use a bit of a refresh! I added two tutorials, replacing the echo service tutorial, and then a shpeal about the benefits after you build your app.

I would love to have a few followup PRs to this, as there are a few things we can still improve.

  • Remove the instruction to wash app undeploy and then deploy, once wadm can support version upgrades
  • Add inline to the "Hello Universe" page exactly how you'd modify the previous manifest to accomplish those changes
  • Add more advanced tutorials for our provided capabilities

Related Issues

Release Information

Consumer Impact

Testing

Built on platform(s)

  • x86_64-linux
  • aarch64-linux
  • x86_64-darwin
  • aarch64-darwin
  • x86_64-windows

Tested on platform(s)

  • x86_64-linux
  • aarch64-linux
  • x86_64-darwin
  • aarch64-darwin
  • x86_64-windows

Unit Test(s)

Acceptance or Integration

Manual Verification

Signed-off-by: Brooks Townsend <brooks@cosmonic.com>

a few small touches on the hello tutorial

Signed-off-by: Brooks Townsend <brooks@cosmonic.com>

wadmified the docs

Signed-off-by: Brooks Townsend <brooks@cosmonic.com>
@brooksmtownsend brooksmtownsend changed the title [WIP] wadm, wash 0.18, and new tutorials New tutorials with wadm, additional context for our benefits Jul 19, 2023
@brooksmtownsend brooksmtownsend marked this pull request as ready for review July 19, 2023 15:56
@brooksmtownsend brooksmtownsend requested a review from a team as a code owner July 19, 2023 15:56
docs/tour/_category_.json Outdated Show resolved Hide resolved
docs/tour/adding_capabilities.mdx Outdated Show resolved Hide resolved
docs/tour/adding_capabilities.mdx Show resolved Hide resolved
docs/tour/adding_capabilities.mdx Outdated Show resolved Hide resolved
docs/tour/adding_capabilities.mdx Outdated Show resolved Hide resolved
docs/tour/hello_world.mdx Outdated Show resolved Hide resolved
docs/tour/hello_world.mdx Outdated Show resolved Hide resolved
docs/tour/why_wasmcloud.mdx Outdated Show resolved Hide resolved
docs/tour/why_wasmcloud.mdx Outdated Show resolved Hide resolved
4. Do I need to be able to vertically scale my application?
5. Do I need to be able to horizontally scale across multiple instances of my application? What about high availability? How will I handle communication between instances of my application?

**All of the above questions should not influence your application's functional logic, don't need to be considered until after you've already built your application with wasmCloud, and can be freely changed at runtime when you need to.**
Copy link
Member

Choose a reason for hiding this comment

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

This feels like a long paragraph to make bold

Copy link
Member

Choose a reason for hiding this comment

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

maybe "when you need to." -> "whenever needed."

Copy link
Member Author

Choose a reason for hiding this comment

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

Curious if you like the changes, moved up and into an info block with a little bit of rewording.

docs/tour/hello_world.mdx Outdated Show resolved Hide resolved
docs/tour/why_wasmcloud.mdx Outdated Show resolved Hide resolved
docs/tour/why_wasmcloud.mdx Show resolved Hide resolved
Signed-off-by: Brooks Townsend <brooks@cosmonic.com>
Copy link
Contributor

@connorsmith256 connorsmith256 left a comment

Choose a reason for hiding this comment

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

Love the changes

@brooksmtownsend brooksmtownsend merged commit a90d2a2 into main Jul 20, 2023
6 checks passed
@brooksmtownsend brooksmtownsend deleted the feat/wadmify-the-docs branch July 20, 2023 17:29
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.

None yet

3 participants