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 onboarding docs #5455

Merged
merged 2 commits into from
Jul 27, 2021
Merged

Conversation

RayBB
Copy link
Collaborator

@RayBB RayBB commented Jul 22, 2021

Ironically, no associated ticket. I'm just trying to improve our onboarding docs before adding anything about remote development (gitpods / github codespaces).

The improvements are generally:

  • Putting linebreaks in long lines. (this has no visual changes)
  • Wordsmithing - making descriptions shorter and hopefully clearer
  • Removing links that aren't useful
  • Add the docker command to the main readme

I try to err on the side of being as clear as possible for new users.

If you think anything should be phrased differently feel free to edit the pr directly, make a comment, or make a PR.

Stakeholders

@jamesachamp

CONTRIBUTING.md Outdated Show resolved Hide resolved
Readme.md Show resolved Hide resolved
Copy link
Collaborator

@jimchamp jimchamp left a comment

Choose a reason for hiding this comment

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

I think that this will be good to go once the colon is replaced by a period in the Code of Conduct section.

The Installation section is probably fine. I'm assuming that folks will read the Docker readme if they encounter any issues.

Co-authored-by: jimchamp <jameschamp@acm.org>
@RayBB RayBB requested a review from jimchamp July 26, 2021 23:40
Copy link
Collaborator

@jimchamp jimchamp left a comment

Choose a reason for hiding this comment

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

Lgtm. Thanks for all of the work that you're doing to improve Open Library's documentation!

@jimchamp jimchamp merged commit 5c3c9b8 into internetarchive:master Jul 27, 2021
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