Alta Voce Internal Documentation

This site centralizes all internal documentation related to the Alta Voce team, processes, recommendations, guidelines, etc.

Quick Start

For New Collaborators

1. Create your account : Your manager will create an account on the different services
2. Set up your environment : Follow the configuration guides in each section
3. Get trained on tools : Consult the available training documentation

For Developers

1. Clone the repositories : admin-alta.alta-voce.tech (backend) and client-alta.alta-voce.tech (frontend)
2. Set up your local environment : Follow the instructions in Webservices and APIs
3. Understand the architecture : Read the Alta Call Applications section first

Main Access Points

Documentation Structure

• Working at Alta Voce : HR, contracts, on-call, remote work
• Webservices and APIs : Technical documentation of services
• Alta Call Applications : User guides for Alta Call and Admin Alta

Documentation Editing

The documentation source is located in the teal repository.

To edit an existing page, click on the Edit this page link at the bottom of it.

To add a new page:

1. (optional) Add a new directory (e.g: hr or marketing) in the docs directory if you want your page to belong to a new group of pages.
2. Add a new file, e.g: README.md or recruitment-process.md
3. Edit the file
4. (optional) Add the file path and/or its directory to the configuration docs/.vuepress/config.js if you want it to appear in the menu.

Once you have finished writing or editing a page, it may take a few minutes for your changes to be published.

Writing Recommendations

• Do not put anything here that shouldn't be seen by other team members. Everyone in the team can access this documentation.
• Do not include passwords, secrets or other sensitive material
• Documentation syntax uses Markdown