📝(project) add a ralph lrs tutorial #540
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
wilbrdt
force-pushed
the
add-doc-lrs-tutorial
branch
from
c5f9ac0 to
958dad5
Compare
Leobouloc
reviewed
Dec 13, 2023
wilbrdt
force-pushed
the
add-doc-lrs-tutorial
branch
from
dac02ee to
57f66f6
Compare
SergioSim
reviewed
Dec 18, 2023
wilbrdt
force-pushed
the
add-doc-lrs-tutorial
branch
from
57f66f6 to
8b4fea7
Compare
wilbrdt
force-pushed
the
add-doc-lrs-tutorial
branch
3 times, most recently
from
3ebe964 to
8685444
Compare
SergioSim
approved these changes
Dec 28, 2023
wilbrdt
force-pushed
the
add-doc-lrs-tutorial
branch
from
8685444 to
0faa5d1
Compare
New user should be able to run Ralph LRS easily, while being able to grasp the Ralph features. Adding an LRS tutorial à la FastAPI to run Ralph LRS from scratch.
We heavily use `lrs.json.gz` JSON file from Potsie for our documentation. Adding it to the project, and changing `@timestamp` into `timestamp` for all statements in it.
wilbrdt
force-pushed
the
add-doc-lrs-tutorial
branch
from
0faa5d1 to
dfca593
Compare
CSS file for neoteroi OpenAPI plugin was not correctly retrieved by mkdocs, and was not used. Fixing it.
Flarelytics client was referenced in the main theme, but is inexistent and not used. Removing it.
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.
Purpose
New users should be able to run Ralph LRS easily, while being able to grasp Ralph features and configurations.
Proposal
Adding an LRS tutorial à la FastAPI to run Ralph LRS from scratch.
Note, if you want to review the final result:
make docs-serve