Skip to content

docs(walrus-sites): add 'deploy' command docs #2102

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

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

Conversation

ioannischtz
Copy link
Contributor

@ioannischtz ioannischtz commented May 19, 2025

Description

This commit updates the walrus-sites docs for the new 'deploy' command,
which consolidates the functionality of 'publish' and 'update' into a streamlined workflow.

Key changes include:

  • Added a section for the 'site-builder deploy' command in commands.md

  • Added notes guiding users towards the new 'deploy' command.

  • Updated the 'Publishing a Walrus Site' tutorial (tutorial-publish.md)
    to use the 'deploy' command.

  • Added a section about the site_name field of ws-resources.json

    Edit: Note to self --> DO NOT MERGE BEFORE site-builder release

…orial, and add soft-deprecation warnings for the 'publish' and 'update' commands.
@ioannischtz ioannischtz requested a review from giac-mysten May 19, 2025 14:25
Copy link
Contributor

github-actions bot commented May 19, 2025

PR Preview Action v1.6.1

🚀 View preview at
https://MystenLabs.github.io/walrus/pr-preview/pr-2102/

Built to branch gh-pages at 2025-06-11 11:00 UTC.
Preview will be ready when the GitHub Pages deployment is complete.

Copy link
Collaborator

@mlegner mlegner left a comment

Choose a reason for hiding this comment

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

Thanks for updating the docs with this new feature. I have a few minor questions.

Also, we should only merge this when a site-builder version supporting this command is released.

…eploy command. add a section about Migrating from publish/update. Update the section about epochs, with the latest information.
…with the latest information. on routing.md add a section about the object_id field.
… commands, since this is to be decided after community feedback.
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