Skip to main content
NearBeach Logo

Updating Documentation

Back to Blogs

Old Documentation

"Document Dept", like tech debt, is real and a massive pain in my [retracted]. For some strange reason, when I go to document NearBeach and it's policies my head goes blank. 30 minutes before I know exactly what I want to write, and exactly what I want to be able to communicate to you, but the instant I am looking at the screen my brain decides to throw those ideas out the window.

Documentation is meant to be updated frequently - which is something I have not been doing. It has sadly been siting there gaining a stagnant smell. Which has sadly resulted in the current documentation

Improvements

The next step I am doing is reviewing ALL documentation for NearBeach. This will be from

  • Setting up a local development environment
  • Setting up a production version of NearBeach with docker
    • Keeping the old MAAS document - just for those who like to install NearBeach manually. Though not recommended (as Docker is easier).
  • First steps to setting up NearBeach after installation
  • Basic usage for NearBeach
  • Developer Information
    • Unit Testing
    • Fixtures - how each object is setup and which user has access to what

This process will be slow, and the documentation will be updated over the next few releases. If anyone needs anything document please contact us in our community on discord.