Website & Documentation Development
Contributions are made via pull requests to the GitHub repository. Changes can be authored via the GitHub web interface (easy) or in a local repository using your favorite
git client (recommended).
If your changes modify non-Markdown files, it is strongly recommended to work on a local clone of the repository rather than within the GitHub web interface.
GitHub Web Interface
Click the "Edit this page" link at the bottom of a documentation page.
Make your changes in the GitHub web editor.tip
For supported Markdown features, please refer to the Docusaurus documentation.
Select the "Create a new branch for this commit and start a pull request." option at the bottom of the page.
Local Git Repository
- Git (the below instructions assume you are using the CLI, though GUI clients will also work!)
- Code editor (Visual Studio Code is recommended)
1. Clone the Repository
Fork the repository.
Create a local clone of the repository:
git clone https://github.com/<your_github_username>/resoto.com.git
This will create a directory named
resoto.comin your current working directory.
Add a remote pointing to the upstream repository (as opposed to your fork) named
git remote add upstream https://github.com/someengineering/resoto.com.git
Create a new branch from
main(it is recommended to give your branch a meaningful, descriptive name):
git checkout -b <branch_name> main
If there are new commits to the
main branch of the repository, you can update your branch by rebasing from your
git fetch upstream
git rebase upstream/main
2. Start the Development Server
Now, we are finally able to get to the fun stuff! 🥳
Start a local development server:
You will notice that
http://localhost:3000has been opened in your browser, where you can see your changes reflected live.note
Older docs versions and some MDX plugins are disabled in development mode to improve performance.
If you would like to test your changes with these enabled, you can run
yarn buildand then
yarn serveto start a local server with the production build.
3. Test Your Changes
After you are done authoring your changes, you'll want to verify your changes will pass the required checks:
Optimize SVG images with SVGO:
Format your code with Prettier:
Lint your code with ESLint:
Trigger a production build:
This will create a
builddirectory containing the static website. You can preview the build locally by running
The build may take several minutes to complete. It is possible to perform a faster build with older docs versions and some MDX plugins disabled:
4. Push Your Changes
Ready to submit your changes for review?
Commit them to your local repository:
Push them to your fork:
git push --set-upstream origin <branch_name>note
To update your fork after a rebase, you may need to force push:
git push -f origin <branch_name>
You are welcome to open your pull request as a draft for early feedback and review.note
Be sure to follow the pull request template!info
Pull request titles should follow the Conventional Commits specification.
However, do not worry too much about getting this right, as we will make any necessary adjustments prior to merging your changes.