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

Restructure "Authoring Content" section #231

Open
smashwilson opened this issue Mar 14, 2016 · 0 comments
Open

Restructure "Authoring Content" section #231

smashwilson opened this issue Mar 14, 2016 · 0 comments
Assignees

Comments

@smashwilson
Copy link
Member

The organization of the "Authoring Content" section is not great right now. We have:

  • "Opening blurb that's probably too technical"
  • "Adding a new repository, the happy path"
  • "Over-detailed explanation about content mapping that you probably don't need to know yet"
  • "Tiny pull request builder section"
  • "Way too much information about setup for non-happy paths"
  • Then: "Links to specialized info about Jekyll/Sphinx."

I'd like to break it up and shuffle things around a little to be more useful. Here's what I'm thinking now:

  • "Setting Up"
    • Summarize the prerequisites. A GitHub account, knowing where the control repository is, that kind of thing.
    • Existing "Adding a new repository" section.
  • "Actually Writing"
    • Specialized Jekyll/Sphinx sections
    • Tips and command cheatsheet for git and GitHub workflow
    • Using the pull request builder
    • Troubleshooting: build failures, preparer failures, ...
  • "Publishing"
    • "Where your content will live"
  • "Special Cases"
    • "Custom Content Repositories" and other things that don't fit the happy path.
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

1 participant