Appearance

NaviStone Contributing Guide ​

Hi! We're really excited that you are interested in contributing to the NaviStone Documentation. Please read all the directions below!

Before we dive into making changes, please do 3 things...

  1. Do a quick overview of the GitLab Basics to better familiarize yourself with Gitlab! You are going to need it!
  2. Learn Markdown. Everything is written in Markdown. Here is a Guide to using markdown.
  3. Understand how the project is structured. I would go into the Iris repository and click around within the docs folder while looking at the documentation site.

Getting everything setup ​

Whenever we make changes in Gitlab, we always want to create a new branch. These make it easy for multiple people to be working on the same project at a time.

  • Go to the Iris Repository within Gitlab.
  • Please follow this short guide to create your first branch. Make sure you that give it a meaningful name and the create from section says develop.
  • Now, that we have created our branch, we should be able to see its name selected in the dropdown next to the client-portal-ui label.
  • We are ready to make changes! Please go down to the next section!

Updating the Docs ​

First things, first! Let's have you jump into the docs folders!

  • Click on the docs folder listed. It should take you to a screen that has .vitepress displayed.

Now, we need to teach you how to use VitePress! I highly recommend checking out their docs here. I've also included a few links and tips below to offer more help!

How to add a new page ​

  • Adding a new page to your Vitepress site is as easy as creating more markdown files to your project.
  • Your first step should be to figure out if you want to create a new section or add to an existing one.
    • For example: The Guide folder is a section while introduction.md is a file for that section.
  • We can do this through gitlab by following this quick guide. Remember to set the file type and put .md at the end and giving it a meaningful commit message.
    • Example: A new file called my-new-file.md for the guide section would look like the diagram below.
  • You will want to go ahead and add whatever documentation you want to this file.
sh
    ├── docs/
    │ ├── .vitepress/
    │ ├── contributing/
    │ ├── guide/
    │ │ ├── introduction.md
    │ │ └── my-new-file.md
    │ ├── public/
    │ └──  index.md

Rolling out your new Changes! ​

  • For each change that you make within gitlab, it goes ahead and creates a commit for you! So, all that's left is creating a merge request.
    • Please follow this link to learn how to create merge requests.
      • All merge request need to merge into develop.
      • Assign the owner of the repository as the reviewer.
    • Once you are done, please let the owner of the repository know so that he can review your changes.
      • If there are no issues the owner, will approve your changes, roll them into develop, and deploy them.
      • If there are issues, comments will be documented in the overview of the merge request focusing on what you need to look at.
        • Your reviewer will let you know when they are ready and will help you work through them.

Issue Reporting Guidelines ​

Please create a new task on the Elysium board with the following information...

  • A meaningful name
  • Tags - Task, Squad::Elysium, Product, Documentation, Bug, Status::Research/Spec
  • Epic - Platform Support

© NaviStone 2025