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

Documentation needs to be updated to reflect changes in the latest codebase. #272

Closed
4 tasks done
broxen opened this issue Mar 12, 2018 · 7 comments
Closed
4 tasks done
Assignees
Labels
good first issue Great issue for newcomers looking for ways to contribute non-programmer Requires no programming ability review Under review

Comments

@broxen
Copy link
Collaborator

broxen commented Mar 12, 2018

The READMEs need to be updated and reviewed for conformity with the latest changes to the server, settings.cfg, and dbtool.

Also, this is a good opportunity to interface with the community and take feedback for streamlining/improving the docs for clarity and simplified use, especially for those without substantial coding experience.

There are several READMEs that need to be updated (these are complete in #418):

  • ./README.md - the root directory readme and first thing users see when viewing our GitHub. This should be geared towards a developer audience looking to compile, BUT needs to provide quick links and clear instructions on where to find our installation and setup guides (and readme)
  • ./Projects/CoX/docs/README.md - This readme will appear in the SEGS program (out) directory. It should be geared towards setting up and running the server. It should be clear and concise, and focus on the most common methods for install (don't need to cover every possible configuration, just the most common ones)
  • ./Projects/CoX/Utilities/dbtool/README.md - an argument might be made for deleting this, but I think it may be valuable to have. At bare minimum we should leave it, and include a link inside to the setup readme in the program directory.
  • ./Projects/CoX/Utilities/piggtool/README.md - an argument might be made for deleting this as well, but I think it may be valuable to have, if it's updated with real instructions. At bare minimum we should leave it, and include a link inside to the setup readme in the program directory.
@broxen broxen added good first issue Great issue for newcomers looking for ways to contribute non-programmer Requires no programming ability labels Mar 14, 2018
@broxen
Copy link
Collaborator Author

broxen commented Apr 6, 2018

As part of this, we should update links to the new segs.io url.

Homepage: https://www.segs.io/ (Under construction! construction)
Forums: https://forum.segs.io/
Twitter: https://www.twitter.com/segscode
Wiki: https://github.com/Segs/Segs/wiki
Discord Server: https://discord.segs.io/
IRC: irc://irc.segs.io/segs

@ldilley
Copy link
Contributor

ldilley commented Apr 6, 2018

An HTTP 301 forwarding rule is in place at the moment for "forum" and "www". If @nemerle can add VirtualHost directives in the webserver's config for "forum" (for the forums), "www" (for the Grav site), and for the base domain (which should just reference "www"/Grav home), then I can remove the forwarding rules and add A records in DNS instead. This would be good for appearance and consistency.

We may also need to regenerate new SSL certificates to add a wilcard (*.segs.io) for proper validation. Additionally, we can optionally make use of Cloudflare caching and protection if desired.

@broxen broxen added the backlog Overdue tasks label Apr 15, 2018
@broxen
Copy link
Collaborator Author

broxen commented Apr 20, 2018

Updated the description with more detail

@broxen
Copy link
Collaborator Author

broxen commented Apr 27, 2018

I'll jump on this next week as work clears up. Please add any comments or suggestions here otherwise I'll work off my own assumptions.

@broxen broxen self-assigned this Apr 27, 2018
@broxen broxen added this to the Version 0.5: The Unsilencer milestone Apr 30, 2018
@broxen
Copy link
Collaborator Author

broxen commented May 4, 2018

Going to incorporate SEGSAdmin into these documents, which should simplify them significantly.

@broxen
Copy link
Collaborator Author

broxen commented May 15, 2018

Needs direction from #317

@ghost ghost added review Under review and removed backlog Overdue tasks labels May 16, 2018
@broxen
Copy link
Collaborator Author

broxen commented May 22, 2018

This is nearly ready for merge. Just going to tweak a couple of URLs.

@ghost ghost removed the in progress label May 29, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Great issue for newcomers looking for ways to contribute non-programmer Requires no programming ability review Under review
Projects
None yet
Development

No branches or pull requests

2 participants