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

Implement review process for changes in the documentation #85

Closed
thechauffeur opened this issue Feb 23, 2015 · 9 comments
Closed

Implement review process for changes in the documentation #85

thechauffeur opened this issue Feb 23, 2015 · 9 comments
Assignees

Comments

@thechauffeur
Copy link
Member

The wiki was good enough for producing content in a collaborative way. Now we have content and need less and smaller changes (regarding lines of text) but a review process for those changes. Sadly the GitHub wikis do not work with pull requests.

Therefore we move the wiki pages to the qabel-doc repository to be able to apply a pull request + review + merge policy.

  • Convert all wiki links to relative links prior migrating the pages (files).
  • Optional: Change history of qabel-doc.wiki (local clone) to let it look like the files have always been in a sub-folder. Do not force push -- just do it locally.
  • Migrate the wiki pages (files) while keeping the history of (local) qabel-doc.wiki via git merge into qabel-doc.
  • Update Home.md in the wiki to refer to the new place of the documentation.
  • Use git rm to remove all files in qabel-doc.wiki except Home.md
  • Review push access to the qabel-doc repository

If you have better ideas let us know it!

@thechauffeur thechauffeur self-assigned this Feb 23, 2015
@thechauffeur
Copy link
Member Author

We would also need to change links in our Javadoc (we have links to some wiki page in some Java files).

@thechauffeur
Copy link
Member Author

@jan-schreib we talked about researching this topic a bit more. Maybe there is a better option than losing the wiki completely etc. (maybe web hooks?).

@jasinai
Copy link
Contributor

jasinai commented Mar 2, 2015

I recommend Github Pages

@thechauffeur
Copy link
Member Author

We will use GitHub pages.

  • Create such a repo from the original doc repo / wiki.
  • Update the old places to reference to the new ones.

@jasinai
Copy link
Contributor

jasinai commented Mar 23, 2015

The documentation is online. For now it is here: https://jasinai.github.io

@thechauffeur
Copy link
Member Author

N1.

  • The documentation page should be the starting page.
  • It is "source code" not "sourcecode".
  • Some pictures break the page.
  • Create qabel github.io repository.
  • We have to link to the new documentation page and not update the old one anymore.

@thechauffeur thechauffeur assigned jasinai and unassigned jan-schreib Mar 23, 2015
@thechauffeur
Copy link
Member Author

  • Add labels.
  • Add milestones.
  • Somehow show pages which are not linked in the new TOC (yaml). E.g. Create a "pages" link which lists all documentation pages with their filename.
  • Remove the old TOC page (md).

@thechauffeur
Copy link
Member Author

@thechauffeur
Copy link
Member Author

The documentation has been migrated.

The qabel-doc repo has been renamed to qabel.github.io. That means GitHub provides a redirect from https://github.com/Qabel/qabel-doc/foo/bar to https://github.com/Qabel/qabel.github.io/foo/bar

This is also true for the wiki and it means we don't need to update anything. Issues, milestones, labels, pull requests, internal links, internal links with fully qualified URL, external links to GitHub etc. Everything should just work.

@Qabel/ackack-developer please open new issues if you find problems. Please create pull requests for the documentation now. Use the this repository.

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

3 participants