Skip to content

[DOP-36248] Update contributing guide for mkdocs#481

Open
dolfinus wants to merge 1 commit intodevelopfrom
improvement/DOP-36248
Open

[DOP-36248] Update contributing guide for mkdocs#481
dolfinus wants to merge 1 commit intodevelopfrom
improvement/DOP-36248

Conversation

@dolfinus
Copy link
Copy Markdown
Member

@dolfinus dolfinus commented Apr 29, 2026

Change Summary

After replacing sphinx with mkdocs some things were not updated properly:

  • towncrier used .rst files instead of .md
  • release & CI workflow instruction relied on .rst files instead of .md
  • Makefile was not updated for sphinx->mkdocs replacement, as well as release instruction.

Fixed.

Related issue number

Checklist

  • Commit message and PR title is comprehensive
  • Keep the change as small as possible
  • Unit and integration tests for the changes exist
  • Tests pass on CI and coverage does not decrease
  • Documentation reflects the changes where applicable
  • docs/changelog/next_release/<pull request or issue id>.<change type>.rst file added describing change
    (see CONTRIBUTING.rst for details.)
  • My PR is ready to review.

@dolfinus dolfinus requested a review from wm-wm-wm April 29, 2026 09:37
@dolfinus dolfinus self-assigned this Apr 29, 2026
@dolfinus dolfinus added the ci:skip-changelog Add this label to skip changelog file check label Apr 29, 2026
@github-actions
Copy link
Copy Markdown

github-actions Bot commented Apr 29, 2026

Coverage

Coverage Report •
FileStmtsMissBranchBrPartCoverMissing
TOTAL103151508185237085% 
report-only-changed-files is enabled. No files were changed during this commit :)

@dolfinus dolfinus force-pushed the improvement/DOP-36248 branch from 4a18fe6 to 70b47d3 Compare April 30, 2026 08:50
@@ -1,5 +1,6 @@
# Changelog { #DBR-onetl-changelog }

- [Next release](./NEXT_RELEASE)
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Нужно, чтобы этот раздел был виден при публикации? В текущей версии он не отображается. Мы хотим поменять практику?


### Features

- sdfafserf ([#1223](https://github.com/MTSWebServices/onetl/issues/1223))
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Это для примера?

```rst
Added support of `timeout` in `S3` connector
-- by :github:user:`someuser`, :github:user:`anotheruser` and :github:user:`otheruser`
```marodkwn title="mddocs/docs/changelog/RELEASE_TEMPLATE/3456.feature.md"
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

опечатка

Suggested change
```marodkwn title="mddocs/docs/changelog/RELEASE_TEMPLATE/3456.feature.md"
```markdown title="mddocs/docs/changelog/RELEASE_TEMPLATE/3456.feature.md"

Comment thread mddocs/docs/nav.md
* [Troubleshooting](troubleshooting/index.md)
* [Spark](troubleshooting/spark.md)
* [Changelog](changelog/index.md)
* [Next release](changelog/NEXT_RELEASE.md)
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Мы точно хотим это видеть в опубликованном сайте?

Comment thread CONTRIBUTING.rst
cp "docs/changelog/NEXT_RELEASE.rst" "docs/changelog/temp_NEXT_RELEASE.rst"

2. Build the Release notes with Towncrier
2. et current release version
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

опечатка?

Suggested change
2. et current release version
2. Build the current release version

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ci:skip-changelog Add this label to skip changelog file check

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants