Docs: Add getting started guide to Ontrack #83
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
✅ Deploy Preview for strong-fairy-c1bde1 ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
satikaj
requested changes
Jul 28, 2024
| These 3 linked repositories are owned by ThothTech and are the ones that you will fork to make your changes. When your changes are approved, they will be merged into these repositories and can later be merged upstream into the [doubtfire-lms](https://github.com/doubtfire-lms) series of repositories. The doubtfire-lms repositories contain all changes that have been accepted. | ||
|
|
||
| ### Development Container | ||
| While working with the OnTrack system, we use a development container. This container includes all the previously listed repositories under one download, and enables you to easily run the OnTrack system. Details on how to set up and run the development container can be found in the [Doubtfire contributing guide](https://github.com/thoth-tech/doubtfire-deploy/blob/main/CONTRIBUTING.md). |
There was a problem hiding this comment.
@JoshuaBourquin could you please change the contributing guide link to the development branch version instead of main
| Then without closing the remote connection to the container, rebuild the container using the Command Palette command (ctrl / cmd + shift + p) ```Dev Containers: Rebuild Container```. | ||
|
|
||
| ##### 2. Docker container related errors | ||
| Sometimes if you are having any weird Docker container related problems such as shown below, you might need to delete all **Containers, Images, and Volumes** related to **doubtfire-lms/formatif** from inside the **Docker app** and restart the **Docker Engine**. |
There was a problem hiding this comment.
Please also add a reminder to check if any updates are pending for Docker. Not updating the app might disrupt its behaviour as well.
| ### Documentation and Templates | ||
|
|
||
| #### Documentation Repositories | ||
| Currently, ThothTech has 2 documentation repositories, [ThothTech/documentation](https://github.com/thoth-tech/documentation) and [ThothTech/ThothTech-Documentation-Website](https://github.com/thoth-tech/ThothTech-Documentation-Website), which is the repo site is located on. The ThothTech Documentation Website is the most current repository, which is being actively worked on and where all new documentation should be placed. |
There was a problem hiding this comment.
This part needs to be changed. documentation is for internal docs, anything we can't release to the public like docs about new features we are working on. ThothTech-Documentation-Website is the external docs repo, anything we have that helps introduce new members into the company and products
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 change adds a beginner guide for OnTrack, which talks through the setup process to start contributing and likely errors they may face. It also includes links to libraries and packages that OnTrack uses as well as a general overview of the system.
Type of change
Testing Checklist
Checklist