search

FrancesCoronel / apprenticeships

Dev & design apprenticeships to the rescue! 🔧
https://apprenticeships.me
MIT License
279 stars 69 forks source link

Create a website 🌐️ #8

Closed FrancesCoronel closed 5 years ago

FrancesCoronel commented 6 years ago

As the list grows, so will the pain of navigating through a Markdown list.

I would go with Airtable but the platform was not meant for open source collaboration.

Having a website or open source spreadsheet like configuration would be the better option.

Docsify seems like the best option right now but I would like to look into other open source options.

✅️ By submitting this issue, I have verified the following

FrancesCoronel commented 6 years ago

Creating a static site with Hugo & Algolia now seems like the better option. Will start working on this soon enough! 😄

tirzah-dev commented 6 years ago

Should the site allow viewers a way to submit apprenticeship programs they are aware of to be added to the list? Also, will the list be searchable by location and program focus?

FrancesCoronel commented 6 years ago

@Tirzahe The idea would be to maintain the list of apprenticeship programs through the website instead of the README.

Since Hugo is a static site generator, this will end up being relatively straightforward since for every new apprenticeship program, a new Markdown file would end up being the entirety of the PR.

The list could be filtered by location and would be searchable by all text.

I haven't had the bandwidth lately to get this started but I'll link some resources for future reference.

https://forestry.io/blog/search-with-algolia-in-hugo/

https://code.luasoftware.com/tutorials/algolia/add-algolia-search-to-hugo-static-website/

Ultimately, the stack would be the JAMstack with the main tools being Hugo, Algolia and Netlify.

https://gohugo.io/ https://www.algolia.com/ https://www.netlify.com/

benjaminmodayil commented 5 years ago

Hi @fvcproductions, are you looking for someone to create the site using the above stack and tools? I would love to help with this if you'd like.

FrancesCoronel commented 5 years ago

@benjaminmodayil That would be amazing - I'll go ahead and add you as a contributor and feel free to go ahead and create a PR with some initial scaffolding so we can get a discussion started. Everything would stay in the same repo.

But yeah, ideally we would Hugo for the base CMS and Algolia for easy searching. Each apprenticeship would just be a Markdown file with data fields like "location" and "description" being located in the front matter.

That's basically it. The theme would ideally be something super simple (like this: https://github.com/nanxiaobei/hugo-paper) but we can definitely iterate on that together.

Let me know if you have any questions!

FrancesCoronel commented 5 years ago

Some other things I'd like to happen in the future that I'll add in once a website is more finalized.

benjaminmodayil commented 5 years ago

Awesome. I'll get started tomorrow on this and will reach out with that initial PR.

benjaminmodayil commented 5 years ago

As the design progresses, there are a few questions that I'm trying to figure out.

  1. Is there a unique title for the site?
  2. What is the end result's domain? Is it apprenticeships.fvcproductions.com?

I'm just trying to figure out if a site title is needed anywhere and how a user might visit the site.

FrancesCoronel commented 5 years ago

@benjaminmodayil I've looked into domains and I think a good name for this repo and the website moving forward could be "Become an Apprentice".

The domain right now is definitely temporary but ideally, if we're going to go with that title, we can make it "become-an-apprentice.com" - open on Google Domains for $12/year.

What are your thoughts on this?

I want to make sure the domain and repo are similar if not the same but a lot of apprenticeship related domains are taken.

"apprenticeships.me" is open for $20/year and also has a nice ring to it.

benjaminmodayil commented 5 years ago

@fvcproductions

I like apprenticeships.me and how that sounds. I'm not too sure about become-an-apprentice. I think having hyphens might not be ideal for someone going to the site, but I'm not too sure. I think this is something that can wait though. I just wanted to know if the site was going to have a title on the page so I can assign a spot for it.

Plus, whatever is chosen as the title probably should be reflected in the domain as well. I'll take a look at other possible options, but I think "apprenticeships.me" is the top choice at the moment.

FrancesCoronel commented 5 years ago

Done - but needs more fine tuning - will add issues to address these.