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 #1

Open
ebeshero opened this issue Jun 19, 2018 · 2 comments
Open

getting started #1

ebeshero opened this issue Jun 19, 2018 · 2 comments
Labels
good first issue Good for newcomers

Comments

@ebeshero
Copy link
Member

ebeshero commented Jun 19, 2018

@KellieDC @lmwilson I've just created the DM_documentation repository in our Digital Mitford organization here on GitHub.

You can clone our new repo here by visiting its main address here: https://github.com/DigitalMitford/DM_documentation , or by clicking on the "Code" tab on this page. Notice the different tabs available here:

  • The Code view (on the far left) lets you see the files and file directories we push.
  • The Issues tab lets us open up dialogues with each other on particular things we need to work on.
  • There's a Project tab: We can open a new Project if we want to work on a blast on work on something specific and organize a set of issues to work on stages of completion. It's a little clunky to use, but can be satisfying to move "Issues" across to completion columns. We can test that out if you like.

I've also created a Jekyll website to be able to run on our repo: https://digitalmitford.github.io/DM_documentation/ Basically, Jekyll is a set of web styles for publishing simple websites from GitHub repos, and it's great for posting official documentation for our whole team. We can post files written simply in GitHub's markdown, which you can read about here: https://guides.github.com/features/mastering-markdown/ Markdown is great for us b/c it's designed to help feature codeblocks as code (unlike Google Docs which isn't well optimized for that).

NOTE: This new repo is separate from the Site Index repo we made at the Coding School, because SI work is its own Major Area of Work! You can find all our repos together in the Digital Mitford organization here: https://github.com/DigitalMitford

@ebeshero
Copy link
Member Author

ebeshero commented Jun 19, 2018

To publish documentation as part of the little website on this repo, we save markdown files (with file extension .md) in the docs directory. We'll need to add links to connect multiple pages together, but we'll cross that bridge when we get to it.

@ebeshero ebeshero added the good first issue Good for newcomers label Jun 19, 2018
@ebeshero
Copy link
Member Author

Notice the labels on the right of the Issues panel...We can modify these if we want, but Github provides a nice set to help distinguish particular kinds of issues (questions, bugs, etc).

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

No branches or pull requests

1 participant