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

Suggested Wiki #11

Open
RCdiy opened this issue Apr 24, 2017 · 1 comment
Open

Suggested Wiki #11

RCdiy opened this issue Apr 24, 2017 · 1 comment

Comments

@RCdiy
Copy link
Contributor

RCdiy commented Apr 24, 2017

Wiki with separate pages

  • instructions for lay person on how to how to create a request/issue to add, modify, update documentation
  • instruction for documenters without admin access
  • instructions for admins
  • workflow overview

Once this is done suggest adding a page in the actual manual letting people know how they can

  • request/issue to add, modify, update documentation
  • help with documentation

Same for main open-tx.org website.

@powercycle
Copy link
Contributor

I'd like to put some form around this issue.

Point 1. We could put some words around it and point them to https://help.github.com/articles/creating-an-issue/

Point 2. I assume that this is for folks without direct access to the opentx repository. How I understand it, you create a clone of the existing repository, make your changes, then create a pull request. I might be missing something though.

Point 3. Although people with direct access to the repository could in fact create branches directly on it, maybe we stick with the same information from Point 2?

Point 4. Suggested workflow might be:

  • Get most recent updates from repository
  • make needed edits
  • create pull request
  • rinse, repeat

We might also consider using something similar to this: https://github.com/opentx/opentx/wiki/Github-issue-workflow

Maybe we just point all references to the completed manual page after we agree on how to contribute?

I have probably over simplified some of what you were trying to accomplish @RCdiy. Please expand on what I've written.

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

No branches or pull requests

2 participants