-
Notifications
You must be signed in to change notification settings - Fork 10
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
Comments
We would also need to change links in our Javadoc (we have links to some wiki page in some Java files). |
@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?). |
I recommend Github Pages |
We will use GitHub pages.
|
The documentation is online. For now it is here: https://jasinai.github.io |
N1.
|
|
|
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. |
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.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.qabel-doc.wiki
viagit merge
intoqabel-doc
.git rm
to remove all files inqabel-doc.wiki
except Home.mdqabel-doc
repositoryIf you have better ideas let us know it!
The text was updated successfully, but these errors were encountered: