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

Address shortcomings in release documentation #181

Open
eecavanna opened this issue Sep 17, 2024 · 0 comments
Open

Address shortcomings in release documentation #181

eecavanna opened this issue Sep 17, 2024 · 0 comments
Labels
cleanup 🧹 Related to cleaning up code, whether its format, organization, variable names, etc. documentation Improvements or additions to documentation x small less than 1 day

Comments

@eecavanna
Copy link
Collaborator

eecavanna commented Sep 17, 2024

Release documentation:

1. Ambiguous working directory

In section "Create and Distribute a new Android build", step 3 shows a shell command (cp ...). When I got to that step, I was still in Android Studio, and so I opened up a terminal window in there. That placed me at some subdirectory instead of at the root directory of the repo. The author of this step intended for the reader to run the command from the root directory of the repo.

Suggestion: Either update the step to indicate the working directory, or update the instructions to guide the reader to return to their original terminal window (not within Android studio), or both.

2. Spelling error

In section "Create and Distribute a new Android build", step 2.iii:

- iii. Deleted ...
+ iii. Delete ...

3. Sacrificing changelog and diff

This one may involve more than just updating documentation; and so may work better as a standalone GitHub Issue.

We noticed that, when we add a build to an existing GitHub Release (instead of creating a new Release), we don't get a changelog or a diff specific to the new build's changes. Maybe we could change our process so that each build also gets its own GitHub Release. If we are going to sunset the PWA, there may be fewer implications to us making such a change to our process.

@eecavanna eecavanna added documentation Improvements or additions to documentation x small less than 1 day cleanup 🧹 Related to cleaning up code, whether its format, organization, variable names, etc. labels Sep 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cleanup 🧹 Related to cleaning up code, whether its format, organization, variable names, etc. documentation Improvements or additions to documentation x small less than 1 day
Projects
Status: Backlog
Development

No branches or pull requests

1 participant