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

Problem: installation guide for devs has too much information #433

Open
5 tasks
codegeschrei opened this issue Jun 1, 2018 · 0 comments
Open
5 tasks

Problem: installation guide for devs has too much information #433

codegeschrei opened this issue Jun 1, 2018 · 0 comments

Comments

@codegeschrei
Copy link
Contributor

codegeschrei commented Jun 1, 2018

Solution: restructure the installation guide and make it more usable

The Installation Guide for Developers needs to be updated and improved.
First of all it is not only an installation guide which is misleading. It is actually a guide to interact with github.
The guide can be merged with Installing from the Source Code.
The guide needs to have a new name and needs to be restructured. It's fine to explain the whole process to get the repository and how to commit+push it when changes were made. But additional to that we need to show how to set up the dev environment properly.

To Do:

  • Don't link to Advanced Installation Options just move it to the section (this should not just be advanced, but also the guide for devs, but only for installation(!)
  • Instead of cloning we should tell developers to fork, linking to the GitHub forking example should be good enough
  • Remove all steps after a successful installation and link to the Contributing section instead
  • Update Installing the Driver to include the way to install alpha, beta, etc: example
  • add pre-commit setup after the installation of the dependencies example

Open for comments/discussion/better ideas

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