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.

Sign up for GitHub

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

Jump to bottom

Update documentation #71

Open
4 tasks
willingc opened this issue Jan 14, 2017 · 3 comments
Open
4 tasks

Update documentation #71

willingc opened this issue Jan 14, 2017 · 3 comments
Assignees
@willingc
Labels
documentation help wanted

Comments

@willingc
Copy link
Contributor

Based on feedback from @ellisonbg's experience with CP deployment, we should update the README and Sphinx docs.

  • Simplify README moving most installation instructions to Sphinx docs
  • Add some UI screenshots to README
  • Add a checklist for pre-deployment tasks
    - Obtain domain name
    - ssh key creation
    - DNS routing for server and domain name
    - encourage letsencrypt (which is working well with current Ansible scripts)
  • Add user friendly walkthrough of consolidated configuration file and suggested settings
@willingc willingc self-assigned this Jan 14, 2017
@rushgeo
Copy link

rushgeo commented Aug 26, 2017

Working on checking the README vs. Sphinx, and testing the deployment and seeing if I have any documentation improvement ideas.

@willingc
Copy link
Contributor Author

Great @rushgeo

@cmyceloso
Copy link

cmyceloso commented Apr 20, 2019 •
edited
Loading

link to the Cal Poly deployment in the README is no longer working, it's now located here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@willingc willingc

Labels
documentation help wanted
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@willingc @rushgeo @cmyceloso