Skip to content

Adjust docs development workflow and add developers' README#1323

Merged
zimnx merged 2 commits intoscylladb:masterfrom
rzetelskik:docs-dev
Aug 16, 2023
Merged

Adjust docs development workflow and add developers' README#1323
zimnx merged 2 commits intoscylladb:masterfrom
rzetelskik:docs-dev

Conversation

@rzetelskik
Copy link
Copy Markdown
Member

@rzetelskik rzetelskik commented Aug 10, 2023

Description of your changes: This PR adds a setup target to docs Makefile and modifies POETRY variable to ensure compatibility for windows, as well as a README for developers as requested in #1308 (comment)

Which issue is resolved by this Pull Request:
Resolves: issues #1308 (comment)

@rzetelskik rzetelskik added kind/documentation Categorizes issue or PR as related to documentation. priority/important-longterm Important over the long term, but may not be staffed and/or may need multiple releases to complete. labels Aug 10, 2023
@rzetelskik rzetelskik added this to the v1.10 milestone Aug 10, 2023
@scylla-operator-bot
Copy link
Copy Markdown
Contributor

Skipping CI for Draft Pull Request.
If you want CI signal for your change, please convert it to an actual PR.
You can still manually trigger a test run with /test all

@scylla-operator-bot scylla-operator-bot Bot added do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Aug 10, 2023
@rzetelskik rzetelskik changed the title [WIP] Adjust docs development workflow and add developers' README Adjust docs development workflow and add developers' README Aug 11, 2023
@rzetelskik
Copy link
Copy Markdown
Member Author

cc @dgarcia360, I can't request a review for some reason

@rzetelskik rzetelskik marked this pull request as ready for review August 11, 2023 07:23
@scylla-operator-bot scylla-operator-bot Bot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Aug 11, 2023
@rzetelskik rzetelskik requested a review from tnozicka August 11, 2023 07:24
@dgarcia360
Copy link
Copy Markdown
Contributor

LGTM

tnozicka
tnozicka previously approved these changes Aug 14, 2023
Comment thread docs/README-dev.md Outdated

## Local preview

To build the documentation locally, run `make setup` first.
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
To build the documentation locally, run `make setup` first.
To build the documentation locally, run `make setup` first to install its dependencies.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

done

zimnx
zimnx previously approved these changes Aug 16, 2023
@scylla-operator-bot
Copy link
Copy Markdown
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: rzetelskik, zimnx

The full list of commands accepted by this bot can be found here.

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@zimnx zimnx merged commit e868c8e into scylladb:master Aug 16, 2023
@rzetelskik rzetelskik deleted the docs-dev branch August 16, 2023 10:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

kind/documentation Categorizes issue or PR as related to documentation. priority/important-longterm Important over the long term, but may not be staffed and/or may need multiple releases to complete. size/S Denotes a PR that changes 10-29 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants