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

Getting Started page #16

Open
gdcutting opened this issue Feb 7, 2019 · 4 comments
Open

Getting Started page #16

gdcutting opened this issue Feb 7, 2019 · 4 comments
Assignees
Labels

Comments

@gdcutting
Copy link
Collaborator

gdcutting commented Feb 7, 2019

Make a page that consolidates resources that will help people get oriented on the project. This could include, but is not limited to:

-Link to slack project
-Link to email group signup
-Brief guide to project communication (a few sentences)
-GitHub Guides

and anything else that might be helpful for people to understand project guidelines, how to communicate, the proper way to contribute, etc...

@gdcutting gdcutting added the good first issue Good for newcomers label Feb 7, 2019
@gdcutting
Copy link
Collaborator Author

Got this started at getting-started.md.

Need to fill out and then link from front page.

@gdcutting
Copy link
Collaborator Author

gdcutting commented Feb 10, 2019

Adding repo links at top. See my working version:
-https://github.com/gdcutting/occam-ra.github.io/blob/intro-material/getting-started.md
-https://gdcutting.github.io/occam-ra.github.io/getting-started.html (at website)

The GitHub links are something of a placeholder. At some point I would like to have this 'getting started' page just link to a single Git(Hub) workflow guide for the project but we don't have that yet. I am fairly close to being able to put one together - I have a number of resources that I posted in the git thread in slack, and I have been looking at other projects' workflow guides to see how established projects are doing it.

Need to think about how to handle project emails. Might want some dedicated ones like bug-reports@occam-ra.io at some point. Thinking about the cleanest way to handle putting maintainer contacts right up front on this page.

@gdcutting
Copy link
Collaborator Author

Haven't forgotten about this. Can we go ahead and get this posted and linked? It's definitely not final but has useful info and we can work on it as we go.

@gdcutting gdcutting self-assigned this Feb 22, 2019
@gdcutting gdcutting pinned this issue Feb 22, 2019
@gdcutting
Copy link
Collaborator Author

Added a couple more links (to docs). This is still work in progress.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant