Welcome to the Visual KPI Documentation repository. This documentation project is powered by Docusaurus, providing a user-friendly and organized platform for learning and reference.
To access the Visual KPI documentation page related to the main branch of this project, use the link below:
To contribute or request modifications and updates, please create an issue. When creating issues, be sure to assign relevant labels to facilitate project organization. You can find a list of existing labels here. Additionally, you have the option to create branches and assign collaborators to them. All new issues are initially allocated to the "ToDo" column within the Project board of the project repository.
The primary branch for this project is the main branch, from which documentation deployments are based. It's crucial to note that direct pushes to the main branch are strongly discouraged. Instead, for any modifications or updates, create a new branch with a descriptive name, and push all your commits to this branch.
Upon completing your work, whether it involves creating new documentation pages or enhancing the documentation's user experience, kindly request a review. After reviewing and addressing any existing bugs or issues, your new branch will be merged into the main branch.
The WriteChoice team takes responsibility for creating and maintaining the documentation. If you're creating an issue related to the documentation content, feel free to assign the issue to one of our WriteChoice members. Additional guidance and support will be provided in the future.
Here, you will find an explanation of the processes related to the management operations inside GitHub.
You will create an issue when:
- You need to fix something inside the documentation.
- A new feature was created for the software and needs to be documented.
- The documentation isn't clear and needs improvements.
- Other modifications are required.
To create an issue, you will follow the steps below:
-
Access the Issue page.
-
Click New Issue.
-
On the new page, you will provide information regarding the task to be executed:
- Define a descriptive.
- Describe the task to be executed.
- Assign the task to a WriteChoice member (Heitor).
- Add labels to the issue. You can find all used labels by Transpara Here. Add at least one priority label.
-
Click Submit new issue.
The person to whom you assigned the issue will be notified. The image below illustrates the steps:
When the WriteChoice team creates or updates some content, they will require a review from Transpara. If you were assigned to review a pull request (PR), you will receive an email informing the PR to review. If you are on the Documentation repository, you can follow the steps below to perform a review:
- Access the Pull Request tab.
- Select the PR you need to review.
- On the PR page, you have access to the commit history and also can access the 😎 Deploy Preview from the Netlify integration.
- Access the Files Changed tab, where you can check all files that have been changed. If you're using the split preview, the original files appear on the left (lines modified are highlighted in red) and the new version appears on the right (modifications are highlighted in green).
- To add a review, move your mouse over the modified file. A blue button will appear on the line beginning. By clicking on it, a review window will appear.
- Add your review regarding the new content. You can tag users on your review by adding @username. After adding the review, click Start Review. You repeat the process as many times as necessary.
- After finishing your review, click Finish your review. The PR owner will be notified. However, we recommend always tagging the content creator to ensure they will be aware of your comments.
Alternatively, to add a comment on specific lines, you can add a general comment. In this case, instead of following the instructions after Step 4 above, you need to click on Review Changes. A preview window will appear where you can provide your review.
If you prefer to leave the comments behind and perform modifications to the file directly on GitHub, follow the steps below, but before complete the steps from 1 to 4, described before.
- When you access the Files Changed, look for the file you want to edit.
- Click on the tree dots (...) button at the right corner of the file window and select Edit file.
- A new page will open where you can edit the file content. Make the necessary modifications.
- After editing the file, click Commit Changes. You need to:
- Provide a commit message. GitHub provides a suggestion that most of the time you can use.
- Add a description to explain your modification. You can use the description field to tag users (@username).
- Be sure to select Commit directly to the branch_name branch.
- Click Commit Changes. A new commit will be created and everyone who has worked on the branch will be notified.
