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.

Sign up for GitHub

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

Jump to bottom

New tutorial #5871

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

New tutorial #5871

wants to merge 5 commits into from
+183 −242

Conversation

s-makin
Copy link
Contributor

@s-makin s-makin commented Nov 14, 2024

Proposed Commit Message

docs: Update tutorials

- Applying extensive feedback from Daniele on our tutorials.
- Tutorials have been streamlined so that we now have a space for
alternative deployment methods (e.g. WSL) to be put under "how-to".
- Tutorials can now be kept for demonstrating features and capabilities.
- Additional tutorials can be created using the LXD quickstart as the basis

Merge type

  • Squash merge using "Proposed Commit Message"
  • Rebase and merge unique commits. Requires commit messages per-commit each referencing the pull request number (#<PR_NUM>)

@github-actions github-actions bot added the documentation This Pull Request changes documentation label Nov 14, 2024
a-dubs
a-dubs approved these changes Nov 14, 2024
View reviewed changes
Copy link
Collaborator

@a-dubs a-dubs left a comment

Choose a reason for hiding this comment

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

One small nit inline, but looks good otherwise!

Cheers, @s-makin

doc/rtd/tutorial/index.rst
or the concepts around it, and are looking to get started as quickly as
possible. Here, you will use an LXD container to deploy a ``cloud-init``
user data script.
This section deploys a cloud-init user data script into a LXD container. It
Copy link
Collaborator

Choose a reason for hiding this comment

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

is "section" the appropriate word here? aren't we referencing a tutorial?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@a-dubs a-dubs a-dubs approved these changes

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
documentation This Pull Request changes documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@s-makin @a-dubs