Improve code clarity for quickstart #587
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mohaids
requested review from
lumjjb,
mrsabath,
mamy-CS and
maia-iyer
as code owners
maia-iyer
requested changes
Feb 25, 2025
There was a problem hiding this comment.
Hello, please follow these instructions to pass the DCO check
docs/quickstart/README.md
Outdated
| @@ -430,6 +430,7 @@ The Tornjak HTTP server is running on port 10000 on the pod. This can easily be | |||
| ```console | |||
| kubectl -n spire port-forward spire-server-0 10000:10000 | |||
| ``` | |||
| 💡 Tip: For optimal performance, run the above command in a new terminal window or tab, depending on your setup. | |||
There was a problem hiding this comment.
💡 Tip: For the following steps to work, run the above command in a new terminal window or tab, depending on your setup.
Signed-off-by: mohaids <mohais@rpi.edu>
Signed-off-by: Maia Iyer <maia.raj.iyer@gmail.com> Signed-off-by: mohaids <mohais@rpi.edu>
Signed-off-by: Maia Iyer <maia.raj.iyer@gmail.com> Signed-off-by: mohaids <mohais@rpi.edu>
xinchaochen8
pushed a commit
to xinchaochen8/tornjak
that referenced
this pull request
Apr 8, 2025
* docs[curriculum]: improved code clarity Signed-off-by: mohaids <mohais@rpi.edu> * Update version to v2.1.0 (spiffe#579) Signed-off-by: Maia Iyer <maia.raj.iyer@gmail.com> Signed-off-by: mohaids <mohais@rpi.edu> * Update version to v2.1.0 (spiffe#579) Signed-off-by: Maia Iyer <maia.raj.iyer@gmail.com> Signed-off-by: mohaids <mohais@rpi.edu> --------- Signed-off-by: mohaids <mohais@rpi.edu> Signed-off-by: Maia Iyer <maia.raj.iyer@gmail.com> Co-authored-by: Maia Iyer <maia.raj.iyer@gmail.com> Signed-off-by: EURICIA <xinchaochen1095@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds a small tip to the quick start documentation by recommending users run a specific command in a new terminal window or tab for optimal performance. This should help avoid potential issues related to running commands in the same session.
Signed-off-by: mohais@rpi.edu