-
Notifications
You must be signed in to change notification settings - Fork 0
Test lint again #5
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
34ae5cb
6e3f8ff
709ffe2
c7c9f4c
e9ebd18
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,21 @@ | ||||||||||||||
| # Another Example Document | ||||||||||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Sugestão de Voz Ativa (AI) 🤖
Suggested change
|
||||||||||||||
|
|
||||||||||||||
| This document is written to show various issues that can be found by a linter. | ||||||||||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Sugestão de Voz Ativa (AI) 🤖
Suggested change
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Sugestão de Voz Ativa (AI) 🤖
Suggested change
|
||||||||||||||
|
|
||||||||||||||
| ## Introduction | ||||||||||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Sugestão de Voz Ativa (AI) 🤖
Suggested change
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Sugestão de Voz Ativa (AI) 🤖
Suggested change
|
||||||||||||||
| The system is designed to be used by all users. It is important that the instructions are followed carefully. | ||||||||||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Sugestão de Voz Ativa (AI) 🤖
Suggested change
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Sugestão de Voz Ativa (AI) 🤖
Suggested change
|
||||||||||||||
|
|
||||||||||||||
| ## Setup | ||||||||||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Sugestão de Voz Ativa (AI) 🤖
Suggested change
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Sugestão de Voz Ativa (AI) 🤖
Suggested change
|
||||||||||||||
| The configuration file is located in the root directory. It is necessary to open it and modify the settings. The server must be restarted after changes are made. | ||||||||||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Sugestão de Voz Ativa (AI) 🤖
Suggested change
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Sugestão de Voz Ativa (AI) 🤖
Suggested change
|
||||||||||||||
|
|
||||||||||||||
| ### Steps | ||||||||||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Sugestão de Voz Ativa (AI) 🤖
Suggested change
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Sugestão de Voz Ativa (AI) 🤖
Suggested change
|
||||||||||||||
| 1. The repository is cloned. | ||||||||||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Sugestão de Voz Ativa (AI) 🤖
Suggested change
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Sugestão de Voz Ativa (AI) 🤖
Suggested change
|
||||||||||||||
| 2. Dependencies are installed. | ||||||||||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Sugestão de Voz Ativa (AI) 🤖
Suggested change
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Sugestão de Voz Ativa (AI) 🤖
Suggested change
|
||||||||||||||
| 3. The database is set up. | ||||||||||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Sugestão de Voz Ativa (AI) 🤖
Suggested change
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Sugestão de Voz Ativa (AI) 🤖
Suggested change
|
||||||||||||||
|
|
||||||||||||||
| > **Note:** The database should be backed up regularly. | ||||||||||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Sugestão de Voz Ativa (AI) 🤖
Suggested change
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Sugestão de Voz Ativa (AI) 🤖
Suggested change
|
||||||||||||||
|
|
||||||||||||||
| ## Troubleshooting | ||||||||||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Sugestão de Voz Ativa (AI) 🤖
Suggested change
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Sugestão de Voz Ativa (AI) 🤖
Suggested change
|
||||||||||||||
| Errors are logged to `/var/log/app.log`. "Permission Denied" errors are often caused by incorrect file permissions. | ||||||||||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Sugestão de Voz Ativa (AI) 🤖
Suggested change
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Sugestão de Voz Ativa (AI) 🤖
Suggested change
|
||||||||||||||
|
|
||||||||||||||
| [Click here for more help](#support) | ||||||||||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Sugestão de Voz Ativa (AI) 🤖
Suggested change
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Sugestão de Voz Ativa (AI) 🤖
Suggested change
|
||||||||||||||
| Original file line number | Diff line number | Diff line change | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,28 @@ | ||||||||||||||||
| # Deployment Guidelines | ||||||||||||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Sugestão de Voz Ativa (AI) 🤖
Suggested change
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Sugestão de Voz Ativa (AI) 🤖
Suggested change
|
||||||||||||||||
|
|
||||||||||||||||
| This document outlines how the application is deployed to production. | ||||||||||||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Sugestão de Voz Ativa (AI) 🤖
Suggested change
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Sugestão de Voz Ativa (AI) 🤖
Suggested change
|
||||||||||||||||
|
|
||||||||||||||||
| ## Prerequisites | ||||||||||||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Sugestão de Voz Ativa (AI) 🤖
Suggested change
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Sugestão de Voz Ativa (AI) 🤖
Suggested change
|
||||||||||||||||
|
|
||||||||||||||||
| Before the installation is started, the following requirements must be met: | ||||||||||||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Sugestão de Voz Ativa (AI) 🤖
Suggested change
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Sugestão de Voz Ativa (AI) 🤖
Suggested change
|
||||||||||||||||
|
|
||||||||||||||||
| Node.js: It is required that Node.js v18 is installed. | ||||||||||||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Sugestão de Voz Ativa (AI) 🤖
Suggested change
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Sugestão de Voz Ativa (AI) 🤖
Suggested change
|
||||||||||||||||
|
|
||||||||||||||||
| Database: A PostgreSQL instance must be provisioned by the infrastructure team. | ||||||||||||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Sugestão de Voz Ativa (AI) 🤖
Suggested change
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Sugestão de Voz Ativa (AI) 🤖
Suggested change
|
||||||||||||||||
|
|
||||||||||||||||
| Permissions: Root access is needed for the initial setup. | ||||||||||||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Sugestão de Voz Ativa (AI) 🤖
Suggested change
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Sugestão de Voz Ativa (AI) 🤖
Suggested change
|
||||||||||||||||
|
|
||||||||||||||||
| ## Installation Steps | ||||||||||||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Sugestão de Voz Ativa (AI) 🤖
Suggested change
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Sugestão de Voz Ativa (AI) 🤖
Suggested change
|
||||||||||||||||
|
|
||||||||||||||||
| The repository can be cloned using the standard Git command. | ||||||||||||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Sugestão de Voz Ativa (AI) 🤖
Suggested change
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Sugestão de Voz Ativa (AI) 🤖
Suggested change
|
||||||||||||||||
| Once the files are downloaded, the dependencies are installed by running npm install. | ||||||||||||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Sugestão de Voz Ativa (AI) 🤖
Suggested change
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Sugestão de Voz Ativa (AI) 🤖
Suggested change
|
||||||||||||||||
|
|
||||||||||||||||
| . Note: The environment variables must be configured before the application is started. | ||||||||||||||||
|
||||||||||||||||
| . Note: The environment variables must be configured before the application is started. | |
| Note: The environment variables must be configured before the application is started. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sugestão de Voz Ativa (AI) 🤖
| . Note: The environment variables must be configured before the application is started. | |
| . Note: The environment variables must be configured before the application is started. | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sugestão de Voz Ativa (AI) 🤖
| . Note: The environment variables must be configured before the application is started. | |
| "You must configure the environment variables before starting the application." |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sugestão de Voz Ativa (AI) 🤖
| ## Configuration | |
| ## Configuration | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sugestão de Voz Ativa (AI) 🤖
| ## Configuration | |
| ## Configuration | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sugestão de Voz Ativa (AI) 🤖
| The configuration file config.yaml is found in the root directory. | |
| The configuration file config.yaml is found in the root directory. | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sugestão de Voz Ativa (AI) 🤖
| The configuration file config.yaml is found in the root directory. | |
| You find the configuration file config.yaml in the root directory. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sugestão de Voz Ativa (AI) 🤖
| Changes can be made to this file to adjust the port settings. | |
| Changes can be made to this file to adjust the port settings. | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sugestão de Voz Ativa (AI) 🤖
| Changes can be made to this file to adjust the port settings. | |
| "You can make changes to this file to adjust the port settings." |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sugestão de Voz Ativa (AI) 🤖
| If an error is encountered, the logs should be checked immediately. | |
| If an error is encountered, the logs should be checked immediately. | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sugestão de Voz Ativa (AI) 🤖
| If an error is encountered, the logs should be checked immediately. | |
| "If an error is encountered, you should check the logs immediately." |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sugestão de Voz Ativa (AI) 🤖
| [Click here for more details]() | |
| `Click here for more details` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sugestão de Voz Ativa (AI) 🤖