TODO: Documentation Update

[ryanlelek]

This issue is a collection of other issues and action items for updating the documentation of Raneto in 2022
(This first post will be edited as issues are reviewed)

Items:

• Explain purpose of the example/ directory to be used as library
  --- Unclear install instructions #324
  --- What if I want to use as library instead run the entire source code? #330
• Emphasize gulp.js static file generation step
  --- Error: Whoops. Looks like this page doesn't exist #293
• Update docs to show examples of special characters in page name
  --- Reporter(s) @benruehl @endo64
  --- Colons cannot be used in page title #298
• Update supported Node.js/NPM versions
  --- (No issue)
• Instructions on update checks
  --- Question: Implementation of update checking #290
• Clarify Stateless Heroku Deployment
  --- Issue: Raneto - Heroku, not saving anything! #267
• Troubleshooting Installation
  --- Raneto will not install #75
  --- Unable to install Raneto on Ubuntu #228
  --- Nodejs 10 causing error in deployment #260
  --- Help with initial configuration #271
  --- Can't install on os x #275
  --- Unclear install instructions #324
• Using Markdown Tables
  --- Table support #184
• Using Markdown Images
  --- Images don't show in preview mode when editing a page. #289
  --- How to show the png images in the page? #359

Nice to Have

• IIS Installation
  --- Reporter(s) @joaorsfonseca @TheGabrielRS @philipstratford
  --- IIS installation #295

[queenkjuul]

The install documentation is pointing me to an /examples directory which 404s - it appears to have been removed from the main branch of the repo? I'm a little lost on how to get up and running. I'm guessing just clone the entire repo and replace the docs with my own?

[ryanlelek]

Hi, thanks for pointing that out.

The example directories have moved to:

• https://github.com/raneto/example (Regular)
• https://github.com/raneto/example-docker (Docker/Container)

in general, I need to dedicate some time to updating the documentation and examples.

If you could, let us know your planned deployment platform (Self-host, Heroku, AWS containers, etc) so I can make sure to cover that

Ryan

[queenkjuul]

Ah there they are, thank you. I would prefer to use docker.