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

Reorganizing README to be compliant with DockerHub upload limit #15

Merged
merged 1 commit into from
May 18, 2020
Merged

Reorganizing README to be compliant with DockerHub upload limit #15

merged 1 commit into from
May 18, 2020

Conversation

brycahta
Copy link
Contributor

Issue #, if available: N/A

Description of changes:

  • Updated README.md to be within DockerHub upload character count limit (25000). Updated char count: 20911
  • Added readme-validator to ensure readme files are below max char count-- this will be invoked by travisci for all PRs
  • Updated sync-readme-to-dockerhub to use $DOCKERHUB_PASSWORD instead of TOKEN as the token is not supported per this issue
  • Kept common use cases and high-level descriptions in main README and moved advanced usage and configuration details to docs/usage.md and docs/configuration.md, respectively.
  • When adding more installation methods, we can create installation.md at that time if we are approaching char limit in main README.
  • Although the main README.md will be the only one synced with DockerHub, validating all .md files to keep them from getting too lengthy

Testing:

  • make clean && make build && make test succeed
  • tested make sync-readme-to-dockerhub on new README with private repo; upload was successful
  • tested make validate-readme on current ReadMes and passed. Also tested on old README (exceeding char count) and test failed as expected

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

Copy link
Contributor

@pdk27 pdk27 left a comment

Choose a reason for hiding this comment

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

Nice refactor. LGTM, left some minor comments.

README.md Outdated Show resolved Hide resolved
docs/usage.md Outdated Show resolved Hide resolved
@pdk27
Copy link
Contributor

pdk27 commented May 18, 2020

Looks good 👍

@pdk27 pdk27 merged commit 3ac0aac into aws:master May 18, 2020
@brycahta brycahta deleted the readme-reorg branch June 15, 2020 22:04
@brycahta brycahta mentioned this pull request Feb 7, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants