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 to assume a less introduced reader #65

Merged
merged 6 commits into from
Apr 13, 2021

Conversation

consideRatio
Copy link
Member

@consideRatio consideRatio commented Apr 12, 2021

I tried to answer some of my own questions by inspecting the code, and updated the readme and added some inline comments to reflect what I learned.

The readme is tweaked a bit based on what I found to improve readability, and i included in this PR some post-migration fixes where the old location of the github repo was still referenced.

@consideRatio consideRatio added the documentation Improvements or additions to documentation label Apr 12, 2021
@manics
Copy link
Member

manics commented Apr 12, 2021

This look like a good time to mention there's a workflow bot that tries to keep dist/ up to date when src changes:

- uses: stefanzweifel/git-auto-commit-action@be7095c202abcf573b09f20541e0ee2f6a3a9d9b
with:
commit_message: "[update-dist-bot] auto-format and update dist"
commit_user_name: update-dist-bot
commit_user_email: update-dist-bot@example.org
commit_author: "update-dist-bot <update-dist-bot@example.org>"

At the moment it uses the default GITHUB_TOKEN which means the CI test won't be re-run after the commit is pushed, so in general you'll need to close and reopen the PR to refresh the tests. Alternative would be to use an access token. https://docs.github.com/en/actions/reference/events-that-trigger-workflows#triggering-new-workflows-using-a-personal-access-token

@consideRatio
Copy link
Member Author

Ahhhh that makes sense, thanks for explaining the reason for the tests to not re-trigger. I understand it is a way to protect against infinite triggering of GitHub workflows.

Copy link
Member

@manics manics left a comment

Choose a reason for hiding this comment

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

A few optional suggestions

README.md 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 Outdated Show resolved Hide resolved
Copy link
Member

@manics manics left a comment

Choose a reason for hiding this comment

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

Cheers

@manics manics merged commit 2c0daf6 into jupyterhub:main Apr 13, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants