Tutorial additions #227
Merged
Tutorial additions #227
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
|
@tonyaldon Would be happy to receive a review and some feedback from you! |
|
Cool @nepet that you've improved the tutorial. I'll look at the PR and go through the tutorial this week ;) |
cdecker
force-pushed
the
202306-tutorial-additions
branch
from
25966b9
to
ba1aa44
Compare
cdecker
previously approved these changes
Aug 4, 2023
docs/src/tutorials/testing.md
Outdated
Comment on lines
134
to
136
| --- | ||
| title: Test network | ||
| --- |
There was a problem hiding this comment.
Mermaid seems not to like this preamble.
|
The tutorial is pleasant to go through. I was able to do the part In
In Can you help me with this step? |
|
Thanks for checking and going through the tutorial. @tonyaldon the wrong path for |
|
I tried to do the part I was on the branch Here is what I did: In @@ -6,6 +6,6 @@ authors = []
license = "MIT"
[tool.poetry.dependencies]
-gl-client = {path = "../gl-client-py"}
+gl-client = {path = "../libs/gl-client-py"}
pytest = "^7.1.2"
python = ">=3.7,<4"On the host, I ran So I ran Then I ran again Despite the error on installing Finally, I ran the command suggested in the error message of |
nepet
force-pushed
the
202306-tutorial-additions
branch
from
128e51e
to
1d4a034
Compare
|
Hey Tony, from the following lines of your output I suspect that you are missing the --- stderr
thread 'main' panicked at 'Could not find `protoc` installation and this build crate cannot proceed without
this knowledge. If `protoc` is installed and this crate had trouble finding
it, you can set the `PROTOC` environment variable with the specific path to your
installed `protoc` binary.If you're on debian, try `apt-get install protobuf-compiler` or download it from https://github.com/protocolbuffers/protobuf/releasesI guess I forgot to add this to the prerequisites section of the tutorial. If one wants to compile These are exactly the kind of inconveniences that I was hoping for you to find, as I start from an already polluted system ^^. Maybe I set up a container environment that allows me to start from scratch in the future 🤔. Thanks for your efforts! |
|
@cdecker All comments with 👍 have been addressed in the latest push/rebase. Working with |
|
@nepet You're welcome! I've just tested it with |
|
Technically we can also change the dependency of @nepet shall we merge as is and we can layer change on top of it later? This is a rather nice change and I'd like to merge it sooner rather than later. |
|
@cdecker sounds good 👍. I just triggered the one failing test for a second run. When the CI is happy I am also happy if you proceed and merge the PR. |
|
Thanks @nepet, I'll take over the PR and shepherd it through CI for you :-) |
cdecker
force-pushed
the
202306-tutorial-additions
branch
from
1d4a034
to
b80f215
Compare
We need to update mkdocs to a version that has the 'social' plugin included. By the way, this commit also adds a docs cache that we could use in CI to avoid potential rebuilds. Signed-off-by: Peter Neuroth <[email protected]>
Signed-off-by: Peter Neuroth <[email protected]>
Signed-off-by: Peter Neuroth <[email protected]>
This makes it more convenient to access built targets, test logs etc. Signed-off-by: Peter Neuroth <[email protected]>
Signed-off-by: Peter Neuroth <[email protected]>
These examples are going to be referenced in the gltesting tutorial. Signed-off-by: Peter Neuroth <[email protected]>
Signed-off-by: Peter Neuroth <[email protected]>
The REPO and REPO_ROOT env vars can only be set via the git command when executed outside of the docker container as the .git dir lives outside of the mounted directory. Signed-off-by: Peter Neuroth <[email protected]>
Signed-off-by: Peter Neuroth <[email protected]>
Signed-off-by: Peter Neuroth <[email protected]>
cdecker
force-pushed
the
202306-tutorial-additions
branch
from
5cc28ff
to
bc51b0f
Compare
cdecker
force-pushed
the
202306-tutorial-additions
branch
from
27d1cb7
to
df8bd72
Compare
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 reworks the
gltestingtutorial.The goal of this PR is to provide a tutorial that developers can follow along and that can be replayed line by line. It it incredibility fragile to work on this because of all things that are cached (e.g. the docker image), so I expect it to fail somewhere on first review ^^.
There are also some convenience additions to the Makefile that help to set up a docker container and mounting points that belong to the user instead of root, so that one can read the
/tmpfiles like the certificates from outside the container without sudo or being root.Bonus points:
This should resolve #166 and resolve #167