search

fraction / oasis

Free, open-source, peer-to-peer social application that helps you follow friends and discover new ones on Secure Scuttlebutt (SSB).
http://oasis-demo.fraction.io
GNU Affero General Public License v3.0
286 stars 42 forks source link

Oasis website #600

Closed Roxxers closed 1 year ago

Roxxers commented 3 years ago

What's the problem you want solved?

It was suggested in the new dev wire chat that we could do with a website for the project.

Is there a solution you'd like to recommend?

With the creation of a new repo (fraction/oasis-website), we can start to build a simple webpage to describe and represent the project in a friendlier way than the current git repos. Both for laypeople and because the current docs and readme's are not amazing. Hosting can be done for free just using github pages so this shouldn't incur any extra cost to the project other than paid hours for development work. Though some money could be spent on a domain for extra ease to end users.

The goal of the site would be a more friendly introduction to the project for both oasis and its desktop variant, install instructions, and maybe some links to describing ssb itself. I would suggest using Hugo as a simple and clean static site builder rather than the project requiring manual html writing for basic edits such as text, links, and images.

Work estimate: for someone knowledgeable about Hugo and basic HTML, CSS, etc. could get this work done within 5 hours.

Powersource commented 3 years ago

@christianbundy What do you think about this? I think @Roxxers is keen on doing it. If you like the idea, could you create a repo in this org for her to work in, or should she start in a personal repo that we later move here?

christianbundy commented 3 years ago

Thanks for pointing this out!

the current docs and readme's are not amazing

I'd love to prioritize fixing the docs and readme, since those are pretty core to Oasis (and even rendered inside Oasis ✨ ). I agree that GitHub doesn't have a great UI for laypeople, and if we have extra time/energy/interest/budget I wouldn't be opposed to displaying our New And Improved Docs on a website.

If we're doing a website, I'd love to use something like Docsify (example: https://dev.scuttlebutt.nz) or auto-generating a Jekyll site from GitHub Pages with a default theme. I'd be very hesitant to add a new codebase that we need to learn and maintain, since Oasis is already under-maintained IMO.

P.S. The problem I'm hearing is ~"github and the current readme/docs are inaccessible to most people", and I'd love to be more explicit about that problem in the future. The problem listed in the issue is "it was suggested [...] that we could _____", which explains a proposed solution rather than the problem. This is important to me because the aim of the Oasis project is to accept patches that are a "[...] minimal and accurate answer to exactly one identified and agreed problem". ❤️

Roxxers commented 3 years ago

P.S. The problem I'm hearing is ~"github and the current readme/docs are inaccessible to most people", and I'd love to be more explicit about that problem in the future. The problem listed in the issue is "it was suggested [...] that we could _____", which explains a proposed solution rather than the problem. This is important to me because the aim of the Oasis project is to accept patches that are a "[...] minimal and accurate answer to exactly one identified and agreed problem". heart

This is mostly my issue and maybe I'm not really giving other people's ideas on this as much spotlight. It is an issue I have and have discussed and is something I want to address but I was wanting to focus on the barebones issues first. I was mostly told to make this issue and it isn't something that has to be worked on right away. The best outcome would be a refactoring the README and reusing a lot of that in the site.

If we're doing a website, I'd love to use something like Docsify (example: https://dev.scuttlebutt.nz) or auto-generating a Jekyll site from GitHub Pages with a default theme. I'd be very hesitant to add a new codebase that we need to learn and maintain, since Oasis is already under-maintained IMO.

I mentioned Hugo because it basically does all of the work of Jekyll without requiring a ruby setup which is very nice. This also includes many default themes and the ability to push to Github Pages. The reason I suggested this be a different repo is not to clutter the main repo. The amount of work from having a site in this repo vs a new one is basically the same if not less.