Skip to content

docs: add readme with links to community docs #4 - #6

Merged
johnsBeharry merged 2 commits into
BitcoinDesign:masterfrom
johnsBeharry:master
Sep 10, 2020
Merged

docs: add readme with links to community docs #4#6
johnsBeharry merged 2 commits into
BitcoinDesign:masterfrom
johnsBeharry:master

Conversation

@johnsBeharry

Copy link
Copy Markdown
Contributor

Problem

  • Meta repo purpose may not be clearly communicated.
  • Difficult to navigate the bitcoin design resources created so far

Solution

Create a README.md

Result

Created a README.md with links to process documents and channels of the bitcoin design slack.

@GBKS

GBKS commented Jul 29, 2020

Copy link
Copy Markdown
Contributor

Looks good. Thanks for getting this going.

@johnsBeharry

Copy link
Copy Markdown
ContributorAuthor

@GBKS whats the procedure to get this merged? lol

@GBKS
GBKS self-requested a review August 7, 2020 07:38

@GBKSGBKS left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Not so sure about the "Getting started" section yet. Getting started could also be about joining the community by registering on Slack, reading up on things and participating in a few conversations. Maybe that could be split into "How to get involved in the community" and "How to get involved in projects", or something like that. For project lists, we also have the Github project boards.

Comment threadREADME.md
Anything related to group consensus and coordination of the Bitcoin Design Community.

### Getting Started
1. Pick existing [project](https://docs.google.com/document/d/1P20rPq6V6w78dXpBqLiiiB-kSypZOzXaG9ZUErYIq28/edit) in the space and do something small

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

My understanding of our process is that we'll use GitHub Projects, so the link should point to the list of active projects on GitHub not a Google doc

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

From the google doc

A more mature idea can be posted as an issue on GitHub (in the most appropriate repository and project board) after some discussion

  1. It seems you can't create GitHub projects unless you are a maintainer of the repo.
  2. I'm not sure how the project setup would work for the external projects like BTC pay.
  3. Would it be best suited to be added to a markdown file until we get the website online with a projects page? WIP; https://github.com/BitcoinDesign/Meta/blob/a14632fe76f00de0c0f25f9f9acd2f67dfc164f8/Projects.md

Comment threadREADME.md
1. Pick existing [project](https://docs.google.com/document/d/1P20rPq6V6w78dXpBqLiiiB-kSypZOzXaG9ZUErYIq28/edit) in the space and do something small
2. If you are passionate. Just do it. Worst case you publish it on your own
3. Contribute to parts of the design guide and website even if it is a slower process to get things approved

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

IMO we should remove negative language like "even if it is a slower process" ... let's be optimistic when introducing new people to the project :)

Comment threadREADME.md
### Projects

- Project list — [Doc](https://docs.google.com/document/d/1P20rPq6V6w78dXpBqLiiiB-kSypZOzXaG9ZUErYIq28/edit)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

same comment as above - need to point to github not google docs

Comment threadREADME.md

- Slack Channel — [#open-design](https://bitcoindesign.slack.com/archives/C015GFYSJNA)
- Discussions -- [Issues](https://github.com/BitcoinDesign/Meta/issues)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

seems like the project lifecycle in the google doc should be placed in markdown on github and then pointed to as part of "governance" (or, process)

Comment threadREADME.md
- Project list — [Doc](https://docs.google.com/document/d/1P20rPq6V6w78dXpBqLiiiB-kSypZOzXaG9ZUErYIq28/edit)

### Governance / Opensource Design

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

maybe use softer language "process" vs. "governance"?

@GBKS

GBKS commented Aug 19, 2020

Copy link
Copy Markdown
Contributor

@johnsBeharry as this is a PR you created, could you please review the outstanding changes @moneyball suggested?

@johnsBeharryjohnsBeharry added the documentation Improvements or additions to documentation label Sep 1, 2020
@johnsBeharry
johnsBeharry merged commit a14632f into BitcoinDesign:masterSep 10, 2020
@Bosch-0Bosch-0 mentioned this pull request Aug 26, 2022
@joseabarreramjoseabarreram mentioned this pull request May 19, 2023
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentationImprovements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@johnsBeharry@GBKS@moneyball