Skip to content
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

Update README.md #120

Merged
merged 3 commits into from
Aug 6, 2024
Merged

Conversation

ovcharenko-di
Copy link
Contributor

fixes #119

Copy link
Contributor

coderabbitai bot commented May 16, 2024

Walkthrough

Изменения в документе README.md сосредотачиваются на обновлении инструкций по загрузке расширений в информационную базу. Внесены уточнения и добавлены шаги, необходимые для загрузки расширений, включая указание имени расширения, метода загрузки, пути или URL для скачивания файла расширения, а также определение этапов, на которых должно быть загружено расширение.

Changes

Файл Описание изменений
README.md Обновлены инструкции по загрузке расширений, включая указание метода загрузки, пути или URL для скачивания, и этапов сборки.

Assessment against linked issues

Objective Addressed Explanation
Добавить в ридми по расширениям инфо о возможности загрузки на разных стейджах (#119)

В лесу, где код как ветер, летает,
Расширения в базу мягко впадают.
Пусть каждый этап будет ясен и прост,
В ридми добавлен нужный нам пост.
🐇✨


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?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 9

Out of diff range and nitpick comments (3)
README.md (3)

Line range hint 212-213: Списки должны быть окружены пустыми строками.

213a214
+

Line range hint 213-215: Используйте символ * для маркированного списка и исправьте отступы.

-  * Если ваши тесты размещены в отдельных расширениях, скопируйте файл `./resources/yaxunit.json` из текущей библиотеки в свой репозиторий (`./tools/yaxunit.json`) и перечислите в нем имена ваших расширений.
-  * Если используется собственный файл `tools/yaxunit.json`, то значение параметра reportPath в нем должно быть равно `./build/out/yaxunit/junit.xml`
+  * Если ваши тесты размещены в отдельных расширениях, скопируйте файл `./resources/yaxunit.json` из текущей библиотеки в свой репозиторий (`./tools/yaxunit.json`) и перечислите в нем имена ваших расширений.
+  * Если используется собственный файл `tools/yaxunit.json`, то значение параметра reportPath в нем должно быть равно `./build/out/yaxunit/junit.xml`

Line range hint 29-30: Используйте форматированный URL.

- См. [памятку по слоям и последовательности сборки](https://github.com/firstBitMarksistskaya/onec-docker/blob/feature/first-bit/Layers.md).
+ См. [памятку по слоям и последовательности сборки](https://github.com/firstBitMarksistskaya/onec-docker/blob/feature/first-bit/Layers.md).
Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between 337d1ee and 274e2a4.
Files selected for processing (1)
  • README.md (2 hunks)

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
@nixel2007
Copy link
Member

А зачем ты нумерацию поменял?

@ovcharenko-di
Copy link
Contributor Author

@nixel2007 нумерация сбивалась, но сейчас я внес исправление, благодаря которому она заработала как надо

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 6

Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between 274e2a4 and 3087a04.
Files selected for processing (1)
  • README.md (2 hunks)

README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated
Comment on lines 188 to 189
* В случае загрузки из исходников - необходимо указать путь к исходникам расширения
* В случае загрузки cfe - Укажите путь по которому будет скачан cfe. На данный момент можно указывать как локальный путь, так и url для скачивания cfe(Прим.: https://github.com/bia-technologies/yaxunit/releases/download/23.05/YAXUNIT-23.05.cfe)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Добавьте пустую строку перед списком для улучшения читаемости.

187a188
+

Committable 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.

Suggested change
* В случае загрузки из исходников - необходимо указать путь к исходникам расширения
* В случае загрузки cfe - Укажите путь по которому будет скачан cfe. На данный момент можно указывать как локальный путь, так и url для скачивания cfe(Прим.: https://github.com/bia-technologies/yaxunit/releases/download/23.05/YAXUNIT-23.05.cfe)
* В случае загрузки из исходников - необходимо указать путь к исходникам расширения
* В случае загрузки cfe - Укажите путь по которому будет скачан cfe. На данный момент можно указывать как локальный путь, так и url для скачивания cfe(Прим.: https://github.com/bia-technologies/yaxunit/releases/download/23.05/YAXUNIT-23.05.cfe)

README.md Outdated Show resolved Hide resolved
- В случае загрузки cfe - Укажите путь по которому будет скачан cfe. На данный момент можно указывать как локальный путь, так и url для скачивания cfe(Прим.: https://github.com/bia-technologies/yaxunit/releases/download/23.05/YAXUNIT-23.05.cfe)
* В случае загрузки из исходников - необходимо указать путь к исходникам расширения
* В случае загрузки cfe - Укажите путь по которому будет скачан cfe. На данный момент можно указывать как локальный путь, так и url для скачивания cfe(Прим.: https://github.com/bia-technologies/yaxunit/releases/download/23.05/YAXUNIT-23.05.cfe)
1. Укажите этапы сборки, на которых должно быть загружено расширение (`initInfobase` -> `extensions` -> `stages`). Если оставить это поле пустым, то расширение будет загружено на этапе `initInfobase` и будет активно на всех последующих этапах. В противном случае расширение будет использоваться только на перечисленных этапах.

Пример конфигурации для загрузки расширений:
```json
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Добавьте пустые строки вокруг блока кода для улучшения читаемости.

192a193
+
194a195
+

Committable 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.

Suggested change
```json
```json

</details>
<!-- suggestion_end -->

<!-- This is an auto-generated comment by CodeRabbit -->

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

Out of diff range and nitpick comments (3)
README.md (3)

Line range hint 30-30: Используйте Markdown для URL, чтобы избежать использования голых ссылок.

- https://github.com/Stepa86/stebi
+ [stebi](https://github.com/Stepa86/stebi)
- https://github.com/firstBitMarksistskaya/onec-docker/blob/feature/first-bit/Layers.md
+ [памятку по слоям и последовательности сборки](https://github.com/firstBitMarksistskaya/onec-docker/blob/feature/first-bit/Layers.md)
- https://jenkins.io/doc/book/pipeline/shared-libraries/#using-libraries
+ [Инструкция по подключению библиотеки](https://jenkins.io/doc/book/pipeline/shared-libraries/#using-libraries)
- https://github.com/bia-technologies/yaxunit/releases/download/23.05/YAXUNIT-23.05.cfe
+ [YAXUNIT-23.05.cfe](https://github.com/bia-technologies/yaxunit/releases/download/23.05/YAXUNIT-23.05.cfe)

Also applies to: 49-49, 116-116, 189-189


Line range hint 73-73: Удалите лишние пустые строки для улучшения читаемости.

72a73
-

Line range hint 9-9: Удалите лишние пробелы в конце строк.

- Строка с лишними пробелами 
+ Строка без лишних пробелов

Also applies to: 85-85, 112-112, 125-125, 162-162

Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between 3087a04 and 1c21631.
Files selected for processing (1)
  • README.md (1 hunks)
Additional comments not posted (6)
README.md (6)

177-177: Добавьте пустую строку перед списком для улучшения читаемости.


179-179: Используйте символ * для маркированного списка.


185-186: Используйте символ * для маркированного списка и исправьте отступы.


188-189: Используйте символ * для маркированного списка и исправьте отступы.


189-190: Списки должны быть окружены пустыми строками.


200-201: Используйте символ * для маркированного списка.

@nixel2007 nixel2007 merged commit 81be466 into firstBitMarksistskaya:develop Aug 6, 2024
1 check passed
@nixel2007
Copy link
Member

Спасибо!

@ovcharenko-di ovcharenko-di deleted the patch-1 branch December 22, 2024 08:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants