docs: add instructions to create the git submodule to README #375
Conversation
JustARatherRidiculouslyLongUsername
temporarily deployed
to
CI Environment
GitHub Actions
Inactive
|
WalkthroughThe update to Changes
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
Outside diff range and nitpick comments (3)
README.md (3)
Line range hint
1-1: Add a blank line before the main heading to adhere to markdown best practices.+ # Fyle Xero APITools
Markdownlint
4-4: Expected: h2; Actual: h3 (MD001, heading-increment)
Heading levels should only increment by one level at a time
8-8: null (MD014, commands-show-output)
Dollar signs used before commands without showing output
9-9: null (MD014, commands-show-output)
Dollar signs used before commands without showing output
7-7: null (MD031, blanks-around-fences)
Fenced code blocks should be surrounded by blank lines
Line range hint
61-61: Clarify the instruction for tailing logs to enhance readability.- * To tail the logs a service you can do + * To tail the logs of a service, you can doTools
Markdownlint
4-4: Expected: h2; Actual: h3 (MD001, heading-increment)
Heading levels should only increment by one level at a time
8-8: null (MD014, commands-show-output)
Dollar signs used before commands without showing output
9-9: null (MD014, commands-show-output)
Dollar signs used before commands without showing output
7-7: null (MD031, blanks-around-fences)
Fenced code blocks should be surrounded by blank lines
Line range hint
79-79: Add the missing article "the" for grammatical correctness.- * To run bash inside any container for purpose of debugging do + * To run bash inside any container for the purpose of debugging, doTools
Markdownlint
4-4: Expected: h2; Actual: h3 (MD001, heading-increment)
Heading levels should only increment by one level at a time
8-8: null (MD014, commands-show-output)
Dollar signs used before commands without showing output
9-9: null (MD014, commands-show-output)
Dollar signs used before commands without showing output
7-7: null (MD031, blanks-around-fences)
Fenced code blocks should be surrounded by blank lines
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- README.md (1 hunks)
Additional context used
LanguageTool
README.md
[uncategorized] ~61-~61: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ...postgres xero_db* To tail the logs a service you can dodocke...
[uncategorized] ~61-~61: Possible missing preposition found. (AI_HYDRA_LEO_MISSING_OF)
Context: ...res xero_db* To tail the logs a service you can dodocker-...
[uncategorized] ~79-~79: You might be missing the article “the” here. (AI_EN_LECTOR_MISSING_DETERMINER_THE)
Context: ... * To run bash inside any container for purpose of debugging do ``` docker-com...
Markdownlint
README.md
4-4: Expected: h2; Actual: h3 (MD001, heading-increment)
Heading levels should only increment by one level at a time
8-8: null (MD014, commands-show-output)
Dollar signs used before commands without showing output
9-9: null (MD014, commands-show-output)
Dollar signs used before commands without showing output
19-19: null (MD014, commands-show-output)
Dollar signs used before commands without showing output
1-1: Expected: 1; Actual: 0; Below (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
7-7: null (MD031, blanks-around-fences)
Fenced code blocks should be surrounded by blank lines
18-18: null (MD040, fenced-code-language)
Fenced code blocks should have a language specified
45-45: null (MD040, fenced-code-language)
Fenced code blocks should have a language specified
51-51: null (MD040, fenced-code-language)
Fenced code blocks should have a language specified
57-57: null (MD040, fenced-code-language)
Fenced code blocks should have a language specified
63-63: null (MD040, fenced-code-language)
Fenced code blocks should have a language specified
69-69: null (MD040, fenced-code-language)
Fenced code blocks should have a language specified
75-75: null (MD040, fenced-code-language)
Fenced code blocks should have a language specified
81-81: null (MD040, fenced-code-language)
Fenced code blocks should have a language specified
Additional comments not posted (1)
README.md (1)
6-10: Ensure the submodule instructions are clear and accessible for users unfamiliar with git.Tools
Markdownlint
8-8: null (MD014, commands-show-output)
Dollar signs used before commands without showing output
9-9: null (MD014, commands-show-output)
Dollar signs used before commands without showing output
7-7: null (MD031, blanks-around-fences)
Fenced code blocks should be surrounded by blank lines
| @@ -3,6 +3,12 @@ Django Rest Framework API for Fyle Xero Integration | |||
|
|
|||
| ### Setup | |||
|
|
|||
| * Add and update the `fyle_integrations_imports` submodule | |||
| ```bash | |||
There was a problem hiding this comment.
Ensure that all fenced code blocks are surrounded by blank lines and specify the language for clarity and proper formatting.
* Add and update the `fyle_integrations_imports` submodule
+ ```bash
$ git submodule init
$ git submodule update
+ ```
* Rename docker-compose.yml.template to docker-compose.yml
+ ```bash
$ mv docker-compose.yml.template docker-compose.yml
+ ```
* The database can be accessed by this command, on password prompt type `postgres`
+ ```bash
docker-compose run db psql -h db -U postgres xero_db
+ ```
* To tail the logs a service you can do
+ ```bash
docker-compose logs -f <api / qcluster>
+ ```
* To run bash inside any container for purpose of debugging do
+ ```bash
docker-compose exec api /bin/bash
+ ```Also applies to: 18-18, 45-45, 51-51, 57-57, 63-63, 69-69, 75-75, 81-81
Tools
Markdownlint
7-7: null (MD031, blanks-around-fences)
Fenced code blocks should be surrounded by blank lines
| @@ -3,6 +3,12 @@ | |||
|
|
|||
| ### Setup | |||
There was a problem hiding this comment.
Consider changing the heading level from h3 to h2 for "Setup" to maintain a proper semantic structure in the document.
- ### Setup
+ ## SetupCommittable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| ### Setup | |
| ## Setup |
Tools
Markdownlint
4-4: Expected: h2; Actual: h3 (MD001, heading-increment)
Heading levels should only increment by one level at a time
JustARatherRidiculouslyLongUsername
temporarily deployed
to
CI Environment
GitHub Actions
Inactive
|
No description provided.