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 documentation for non-developers #40

Open
3 of 7 tasks
JonHMChan opened this issue Apr 8, 2015 · 4 comments
Open
3 of 7 tasks

Update documentation for non-developers #40

JonHMChan opened this issue Apr 8, 2015 · 4 comments

Comments

@JonHMChan
Copy link
Contributor

For myself, @ErinCorleyGray and @hairboat to work on. I've given both point people on the community and marketing teams a training on the workflow, it's time to reflect any gaps in the README.md to make sure anyone knows how to use the blog. Some things to consider:

  • Make the create file, commit, pull request, merge workflow through the GitHub interface very clear. Take someone step-by-step with screenshots/gifs.
  • Make the templates for all new files easy. This includes adding authors, posts, and tags
  • Image workflow. How to upload images, reference them, and modify them (alignment, sizing, captions)
  • Draft workflow. How people create drafts, collaborate on them, and eventually publish them? How about reviewing changes?
  • How do we schedule and manage a constant stream of content? I imagine this is a Trello board @ErinCorleyGray ?
  • Who are the point people for questions about the blog? I'm assuming @ErinCorleyGray and @hairboat for respective teams, and myself for anything else.
  • Suggesting changes using issues.

Anything else I'm missing?

@JonHMChan
Copy link
Contributor Author

@ErinCorleyGray and @hairboat do we think the documentation is sufficient as is? I'm thinking of shipping very soon.

@ErinCorleyGray
Copy link
Contributor

@JonHMChan I think most of it is good, though I think we're still missing some of the image & draft workflow requests. Create, commit, pull request etc is much better. Also missing the stream of content part, but that obviously hasn't been determined yet.

@hairboat
Copy link
Contributor

Do I have to define a source in my header material if I'm just writing a new post?

@hairboat
Copy link
Contributor

Docs say .md but all the posts are .markdown. Can files be either, or is only one correct?

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

No branches or pull requests

3 participants