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

Change quickstart doc piece installation script to use the 'quick start' script. #2311

Merged
merged 2 commits into from
Nov 25, 2024

Conversation

kaelemc
Copy link
Contributor

@kaelemc kaelemc commented Nov 23, 2024

Previously the Quickstart page had the one-liner script that only installed containerlab only and not any of the dependencies.

I think the quicksetup script makes more sense instead of the clab-only install script. This PR does the following:

  • Admonition on the install page under the quicksetup script is now of the 'tip' type (was 'info' before).
  • Quickstart doc page was updated to use the proper quicksetup script (via snippets).
  • Changed the text/explainer slightly to more accurately reflect the quicksetup script. The hyperlink now links to the quicksetup heading as well.

Let me know if you think the admonition should be changed back to info, or something that catches attention more like 'warning'. In fairness the content is important as if the user doesn't follow those instructions their docker install will not be working properly.

@hellt
Copy link
Member

hellt commented Nov 25, 2024

thnx @kaelemc

@hellt hellt merged commit 0ab40c3 into srl-labs:main Nov 25, 2024
1 check was pending
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.

2 participants