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

Move wiki to repo + Automated updating of wiki #1350

Merged
merged 11 commits into from
Sep 13, 2024

Conversation

marc-vdm
Copy link
Member

@marc-vdm marc-vdm commented Aug 28, 2024

What

  • Moves the wiki to this repo
  • Adds script to push changes to the activity_browser/docs/wiki folder to the wiki git
  • Script can be run 2 ways:
    1. when a release is done
      • e.g. for new text related to a new feature release, which should only be visible when the feature is available
    2. or can be manually triggered with manual_update_wiki.yml
      • e.g. for fixing typos or making existing text clearer
  • Only actually pushes changes when changes have been made.

Why

  • To finally start keeping documentation up to date
  • To manage documentation from the same place as AB is found,
    • Allows changes to documentation to be tracked in same PR as changes to features
  • To automatically update documentation when new versions of AB come out with new documentation
    • Only triggers on release so documentation will be up to date with current release
    • Downside is that this means documentation can only be changed with new releases
  • To manually change documentation when needed
  • Docs stored in activity-browser/activity_browser so documentation is shipped with new releases, allowing us to add the full wiki to UI at some point.

Checklist

  • Keep pull requests small so they can be easily reviewed.
  • Update the documentation, please follow the numpy style guide.
  • Update tests.
  • Categorize the PR by setting a good title and adding one of the labels:
    bug, feature, ui, change, documentation, breaking, ci
    as they show up in the changelog.
  • Link this PR to related issues by using closing keywords.
  • Add a milestone to the PR (and related issues, if any) for the intended release.
  • Request a review from another developer.

Resolves #410

@marc-vdm marc-vdm added the documentation PRs that refer to documentation at any level (code, readthedocs, etc.) label Aug 28, 2024
@marc-vdm marc-vdm requested a review from mrvisscher August 28, 2024 13:07
@coveralls
Copy link

coveralls commented Aug 28, 2024

Coverage Status

coverage: 54.099% (-0.03%) from 54.132%
when pulling 29079a4 on marc-vdm:documentation
into 132bd48 on LCA-ActivityBrowser:main.

@marc-vdm marc-vdm marked this pull request as draft August 28, 2024 15:03
@marc-vdm marc-vdm marked this pull request as ready for review August 28, 2024 19:53
@marc-vdm marc-vdm mentioned this pull request Aug 30, 2024
7 tasks
@mrvisscher mrvisscher merged commit 54c987d into LCA-ActivityBrowser:main Sep 13, 2024
9 checks passed
@marc-vdm marc-vdm deleted the documentation branch September 13, 2024 07:46
@marc-vdm marc-vdm added this to the 2.10.2 milestone Sep 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation PRs that refer to documentation at any level (code, readthedocs, etc.)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Putting together Github Wiki pages
3 participants