VRapeutic's Official Documentation Website 📝 💻 🚀

Installation 🖥

Start off by cloning the repository

git clone https://github.com/vrapeutic/vrapeutic.github.io.git
cd vrapeutic.github.io

Install the dependencies using Yarn or NPM

npm install

yarn install

Start Your First Contribution 🌟

Create a development branch

Start off by creating a new branch for your work

git checkout -b <branch-name>

Make your branch name descriptive to the thing you want to work on

Local Development 🧱

After you've done some modifications, you might want to run your changes in your local environment
In order to start the documentation website locally on your local machine, run the following command

yarn start

npm start

This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.

Build 🏗

This is an important step. It compiles the documentation website into a static website
In order to build the documentation website, run the following command

yarn build

npm run build

This command generates static content into the build directory and can be served using any static contents hosting service

Create a PR (Pull Request) ⤴

Once you feel comfortable with your changes, commit you work to your branch

git commit -am "A brief description of your changes"

Make your commit message descriptive to the thing you want to work on
Add some emojis to your commit message to make it easy to identify what you've done
Push your branch to GitHub

git push origin <branch-name>

Go to GitHub and create a pull request
Describe your changes in detail
Include screenshots and animated GIFs to show how your changes look
Wait for the PR to be reviewed and merged
Once merged, changes will be reflected live on vrapeutic.github.io
Hurray!!! You've done an amazing job and we're proud of you! 🚀

Issues 💡

We're really appreciate your keeness to making VRapeutic's documentation website better! 😇
Start off by going to the Issues tab, and create a New Issue
You can choose from different template for the issue (e.g. Bug Report, or Feature Request), or you can just write your own description
Fill out the issue template and submit the issue
If you want to help us out, you can start a discussion on the issue
Make your issue as descriptive as possible, and include as much details as you can
We encourage you to attach images, screenshots, or even use Emjoin to make your issue more visual

Contributors ✨

Thanks goes to these wonderful people (emoji key):

_{Yahya Alaa} 💻 🖋 🎨 📖 🤔 🚇 🚧 📆 🌍	_{Ahmad Al-Kabbany} 💼 🖋 🤔 🧑‍🏫 📆	_{J.W.F. (he/him)} 💬 🐛 🤔 🔧	_{Alaa Hesham} 📝 💻 🖋 🔬
_hadeergamal1 💻 🖋 📖 🤔 📓	_{AhmedAlassasy} 💻 🖋 📖 🤔 📓

This project follows the all-contributors specification. Contributions of any kind welcome!

CI only runs on commits in main branch

Summary

CI checks will not run on Pull Requests, but instead only run on changes in the main branch.

Background

The current Circle CI config is a single-job workflow (build_and_deploy). There is a filter so the job only runs on commits in the main branch. This is good for deploying new changes to your documentation, but we lose the benefit of making sure the documentation site still builds OK on new changes not yet merged to master.

The solution is to split the single job, build_and_deploy, into two separate jobs: build and deploy.

Details

We need two jobs, one to build the Docusaurus site that runs on all changes, and another job to deploy the built site source only for changes added to main branch. The workflows part of the Circle CI config.yml might look like this:

workflows:
  main:
    jobs:
      - build
      - deploy:
          filters:
            branches:
              only: main
          requires:
            - build

Then you need to split it into two jobs. You will need to use persist_to_workspace and attach_workspace to pass the built HTML artifacts from one job to another.

See FOSSRIT/[email protected]/config.yml and FOSSRIT/[email protected]/deploy.sh for examples of this full workflow.

Outcome

All new changes are always confirmed to build successfully, instead of discovering a change doesn't work after getting it into main

vrapeutic / vrapeutic.github.io Goto Github PK

vrapeutic.github.io's Introduction

VRapeutic's Official Documentation Website 📝 💻 🚀

Installation 🖥

Start Your First Contribution 🌟

Create a development branch

Local Development 🧱

Build 🏗

Create a PR (Pull Request) ⤴

Issues 💡

Contributors ✨

vrapeutic.github.io's People

Contributors

Stargazers

Watchers

vrapeutic.github.io's Issues

Summary

Background

Details

Outcome

Recommend Projects

Recommend Topics

Recommend Org