Initialize Github Pages for Docs, Migrate from postybirb.com

[malleyeno]

PR Description

This PR implements a /docs/ folder that contains the files and set-up for a jekyll implemented github pages site for this project.

More steps may be needed to have this ready for publishing, but they may be on the admin/maintainer end.

What I did

• I went through the postybirb website and translated anything I thought was relevant and timely into markdown. I copied over the navigation structure as much as I could.
• I configured the tutorials page as a collection to populate upon jekyll serve and jekyll build. This way, the tutorials page doesn't need to be manually populated when future tutorial pages are written. As an example, I moved the accounts-login tutorials in, and it is populated in the tutorials page with this set up.
• Configuration is set up with some basic details from the repo.
• The feed plugin is enabled here to generate RSS feeds from new posts.

Missing from Migration

• Certain configuration details

  • This is more of a design decision. What should the site's description be? Which links are featured in the footer?
  • There is no hamburger menu, everything is in the top nav-bar.

• Contact forms

  • I am not sure what backend is being used for the feedback forms, so I did not implement this. I imagine this would not be a desirable way of getting bug reports anyway since the issues page is on the repo.

• Translation page

  • The translation page on the site seems to suggest this is for the previous version. I am not sure if this is relevant for future versions or not, so I did not migrate it.

• Assets, images, styling

  • In my view, moving the content is the most critical portion of the site. So I did not migrate image assets or styles yet. (Besides, the minima theme is clean and simple.) I will leave styling decisions up to the maintainers since I suspect they are more aware of how PB should be branded.
  • What is critically missing however are images for the tutorials. There is an asset folder up, but the images were out of date.

• Update blog

  • I am not sure how critical this section is to migrate, so I did not touch it.
  • This set up is blog-ready. _drafts is there for drafting posts, and _posts will host the published articles for a blog. Right now, all blog posts are published to the index page -- this is because of the Minima theme. I suspect this can be changed, but I have not done so here.

Steps needed to publish site/next steps

• Set up the pages tooling in the repo settings to launch a site from this folder.
  • It may also need a github actions workflow to build the site upon changes. Right now, the docs/_site contain the actual built assets that are hosted. I build those with jekyll serve and jekyll build manually.
• Populate assets, images, styling
• Populate tutorials
  • I was going to migrate the tutorials but elected against it as they are for the previous version. I think this is a good exercise for future contributors to create tutorial pages.
  • I have set up the tutorials landing page to automatically update with each new tutorial page in the _tutorials folder.
• Monitor changes for moving to separate repo.
  • Terrence The Fox on discord (apologies for no @, I can't find if he uses a different name on this repo) informed me that it would be more future proof to keep any new doc sites on a separate repo.
    
    If this is the case, then moving the entire /docs folder into the separate repo should work, so long as you make sure to change the baseurl in _config.yml to not use /docs.
  • If you are using a custom domain, you will need to set up the CNAME and change the _config.yml url.
• Create standards for doc contributors
  • Things like where to put images, where to put tutorial articles, and which yaml fields to populate.

[leaftail1880]

Big work, thank you!

[mvdicarlo]

I appreciate the effort. Though I am going to have to think about this for now on whether or not I am okay with going forward with this.

This is tech I haven't really played with and having a github page as the main may not exactly be the best thing moving forward. Although I understand the desire control the app's page through files instead of a website builder tool.

[mvdicarlo]

@malleyeno Hey, I wanted to reach out about this if you're still interest in this in any manner.

Been trying to fill in community gaps and have taken some time to setup an org and and github io page for hosting docs and guides for the app with the intention of having the primary website just being a simple landing portal.

Would you be interested in helping with it? I don't exactly want to toss away the work you put into this and my general knowledge of jekyll is pretty non-existant.

Let me know and I hope you have a good start to your year.

[malleyeno]

@mvdicarlo Hiya, and thanks, hope you had a good year's start as well!

Yes, definitely down to continue to help in this area. Feel free to invite me into the org and I can take a look at the page you have set up. We can also discuss design and structure for the pages over in the discord.

Having the main site act as a landing portal that links to the docs site makes sense to me, since then the docs site could accept community contributions via PR.