-
Notifications
You must be signed in to change notification settings - Fork 131
[Docs] Advanced networking documentation #3166
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
riccardotornesello
wants to merge
22
commits into
liqotech:master
Choose a base branch
from
riccardotornesello:docs/networking
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
[Docs] Advanced networking documentation #3166
riccardotornesello
wants to merge
22
commits into
liqotech:master
from
riccardotornesello:docs/networking
Conversation
This file contains hidden or 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
Collaborator
|
Hi @riccardotornesello. Thanks for your PR! I am @adamjensenbot.
Make sure this PR appears in the liqo changelog, adding one of the following labels:
|
ddcd939 to
780b77a
Compare
91555d4 to
014a8d1
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.
Description
This PR aims to add documentation concerning advanced concepts of the liqo's network fabric.
Contributors
Updates
Documentation
The main contribution concerns the addition of a section on Liqo's architecture, specifically its network architecture.
The following pages have been added to Architecture / Liqo's network:
Sphinx
The Sphinx installation system has been changed: currently, the packages needed to compile the documentation are installed without a Python virtual environment, but this is no longer supported by default in new versions of PIP, so it has been necessary to use virtual environments in the Makefile.
Furthermore, to make local execution lighter and simpler, Nginx (via Docker) has been replaced with the native Python “http” module, which allows a static http server to be exposed.
Finally, the README has been modified to suggest that users use the autoserve command, which is more useful during development than serve thanks to its autoreload feature.