documentation icon indicating copy to clipboard operation
documentation copied to clipboard

Proposal: move all documentation to pelias/pelias for hosting on https://pelias.io

Open orangejulius opened this issue 6 years ago • 2 comments

We originally have this documentation repo only because Mapzen needed project documentation to be in its own repo so that it could be easily deployed to the Mapzen website. Back then, we didn't really even fully articulate the differences between Mapzen Search (Mapzen's hosted instance of Pelias), and Pelias itself.

At this point all that is history, and we can consider what we could gain by making the main source of Pelias documentation hosted on the Pelias website, https://pelias.io

Here are some:

  • One less repo :)
  • Having the main source of Pelias documentation on a website allows us to customize how it's displayed
  • We would be able to build up the SEO presence of the pelias.io site by linking to it much more heavily
  • It's very hard to do "redirects" on GitHub, we have lots of files that basically say "documentation moved to somewhere else" since we can't delete the original file without breaking links

orangejulius avatar Nov 26 '19 16:11 orangejulius

@missinglink any thoughts about moving most content out of pelias/documentation into pelias/pelias?

orangejulius avatar Nov 27 '19 20:11 orangejulius

Sounds like a good idea in principle but I would hold off until after I have met with the Ura Design agency.

I'm hoping that they will be able to provide an external perspective on the documentation that would make it more accessible to novice and experienced users alike.

missinglink avatar Nov 28 '19 10:11 missinglink