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: complete host config transition to cli reference #726

Open
wants to merge 7 commits into
base: main
Choose a base branch
from

Conversation

ericgregory
Copy link
Contributor

@ericgregory ericgregory commented Nov 21, 2024

We don’t want redundant references since that’s confusing and defeats the point of auto-documenting the host CLI, but some information needs to be transferred over to the new wasmCloud CLI reference page because clap-markdown isn’t currently generating documentation for hidden options. This PR does that plus some other bits of clean-up and finalization:

  • Removes old host-config page
  • Updates host config page to remove old options and add new ones
  • Adds introduction to wasmcloud CLI reference
  • Updates redirects
  • Updates links
  • Updates pages with out-of-date references to host options
  • adds instructions on generating wasmcloud CLI reference to contributing guide

@ericgregory ericgregory requested a review from a team as a code owner November 21, 2024 17:42
Copy link

netlify bot commented Nov 21, 2024

Deploy Preview for dreamy-golick-5f201e ready!

Name Link
🔨 Latest commit ea4b485
🔍 Latest deploy log https://app.netlify.com/sites/dreamy-golick-5f201e/deploys/6740aac547d30b0008fd0723
😎 Deploy Preview https://deploy-preview-726--dreamy-golick-5f201e.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

docs/cli/wasmcloud.mdx Outdated Show resolved Hide resolved
docs/concepts/hosts.mdx Outdated Show resolved Hide resolved
docs/deployment/hosts/labels.mdx Outdated Show resolved Hide resolved
docs/deployment/hosts/local-artifacts.mdx Outdated Show resolved Hide resolved
docs/deployment/netconf/registries.mdx Outdated Show resolved Hide resolved
docs/deployment/netconf/registries.mdx Outdated Show resolved Hide resolved
docs/deployment/observability/logs.mdx Outdated Show resolved Hide resolved
ericgregory and others added 4 commits November 21, 2024 14:10
Co-authored-by: Victor Adossi <[email protected]>
Signed-off-by: Eric Gregory <[email protected]>
Co-authored-by: Victor Adossi <[email protected]>
Signed-off-by: Eric Gregory <[email protected]>
Co-authored-by: Victor Adossi <[email protected]>
Signed-off-by: Eric Gregory <[email protected]>
Co-authored-by: Victor Adossi <[email protected]>
Signed-off-by: Eric Gregory <[email protected]>
Copy link
Contributor

@lachieh lachieh left a comment

Choose a reason for hiding this comment

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

Deferring to @vados-cosmonic for this one. Approving so that it can merge after comments have been addressed.

@ericgregory
Copy link
Contributor Author

Latest commit restores host config page, brings it up to date, and links it where appropriate. So for the moment, we have autogenerated host CLI reference as well as the host config page, now current and aligned. I'm going to open an issue (in wasmcloud/wasmcloud since it'll focus on the host binary) on reducing redundancy and streamlining/standardizing process.

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