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.

Sign up for GitHub

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

Jump to bottom

Versioning for Python docs #1375

Closed
bossenti opened this issue Mar 2, 2023 · 0 comments · Fixed by #1397
Closed

Versioning for Python docs #1375

bossenti opened this issue Mar 2, 2023 · 0 comments · Fixed by #1397
Assignees
@bossenti
Labels
documentation Everything related to documentation enhancement New feature or request python Pull requests that update Python code
Milestone
0.91.0

Comments

@bossenti
Copy link
Contributor

bossenti commented Mar 2, 2023 •
edited
Loading

Body

Currently, our documentation for the Python lib is unversioned.
This should be changed to be able to differentiate between the currently released version and the development state at least (ideally also for all hostoric releases). Therefore, our Mkdocs setup should be configured accordingly.
Here are some information about it from the official documentation:
https://squidfunk.github.io/mkdocs-material/setup/setting-up-versioning/

As a first step it would be great to have it running with some sample commands.
Ideally, this would already be integrated with our GitHub workflow.

Mentoring

As this issue is marked as good first issue: one of @dominikriemer, @tenthe, or @bossenti are happy to provide help for getting started, just tag (one of) them if you want to start working on this issue and need some help.
This issue is ideal for people that are interested in getting started with StreamPipes and already have some experience with Mkdocs.

StreamPipes Committer

I acknowledge that I am a maintainer/committer of the Apache StreamPipes project.
@bossenti bossenti added enhancement New feature or request good first issue Good for newcomers python Pull requests that update Python code documentation Everything related to documentation labels Mar 2, 2023
@bossenti bossenti added this to the 1.0.0 milestone Mar 2, 2023
@bossenti bossenti removed the good first issue Good for newcomers label Mar 3, 2023
@bossenti bossenti self-assigned this Mar 3, 2023
@bossenti bossenti modified the milestones: 1.0.0, 0.91.0 Mar 6, 2023
bossenti added a commit that referenced this issue Mar 6, 2023
@bossenti
add mike as versioning provider for python docs (#1375)
2289193 
Signed-off-by: bossenti <[email protected]>
bossenti added a commit that referenced this issue Mar 6, 2023
@bossenti
adapt GitHub workflow for python docs creation (#1375)
60fc13e
bossenti added a commit that referenced this issue Mar 7, 2023
@bossenti
adapt GitHub workflow for python docs creation (#1375)
752932f
bossenti added a commit that referenced this issue Mar 7, 2023
@bossenti
add doc releasing to python deployment (#1375)
cf02ed6
@bossenti bossenti linked a pull request Mar 7, 2023 that will close this issue
[#1375] add versioning to python docs #1397
Merged
1 task
bossenti added a commit that referenced this issue Mar 8, 2023
@bossenti
retrieve release version from branch name (#1375)
de18901
bossenti added a commit that referenced this issue Mar 10, 2023
@bossenti
[#1375] add versioning to python docs (#1397)
c530d55 
* add mike as versioning provider for python docs (#1375)

Signed-off-by: bossenti <[email protected]>

* adapt GitHub workflow for python docs creation (#1375)

* add doc releasing to python deployment (#1375)

* retrieve release version from branch name (#1375)

---------

Signed-off-by: bossenti <[email protected]>
bossenti added a commit that referenced this issue Mar 10, 2023
@bossenti
[#1375] add versioning to python docs (#1397)
9070160 
* add mike as versioning provider for python docs (#1375)

Signed-off-by: bossenti <[email protected]>

* adapt GitHub workflow for python docs creation (#1375)

* add doc releasing to python deployment (#1375)

* retrieve release version from branch name (#1375)

---------

Signed-off-by: bossenti <[email protected]>

[#1375] add versioning to python docs (#1397)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@bossenti bossenti

Labels
documentation Everything related to documentation enhancement New feature or request python Pull requests that update Python code
Projects
None yet
Milestone
0.91.0
Development

Successfully merging a pull request may close this issue.

[#1375] add versioning to python docs apache/streampipes
1 participant
@bossenti