devsofcolour icon indicating copy to clipboard operation
devsofcolour copied to clipboard

🍑 Spin up SSG

Open tatianamac opened this issue 6 years ago • 33 comments

Simpler seems better here, something where markdown or another FMD approach can allow for easy profile creation.

tatianamac avatar Jul 30 '19 19:07 tatianamac

What about this for approach?

  1. Spin up site.
  2. Create some sort of database that can be contributed to, like we've discussed via .md files or JSON or whatever.
  3. Gather 10 or so user's data so we can start to have some real data to design around.
  4. Design the thing.
  5. Get more users to start stress testing it.

tatianamac avatar Aug 12 '19 21:08 tatianamac

Sounds good to me @tatianamac

taurean avatar Aug 12 '19 22:08 taurean

SSGs like Gatsby and Gridsome offer a simple enough GraphQL setup to work with straight markdown files. I'm new to Eleventy, so I'm not sure how to set one up there, but ultimately, a potential setup could be a directory with markdown files, ${framework}-source-filesystem to set the GraphQL relationship between the markdown and graph, and then programmatically create pages based on a template from there.

cdvillard avatar Aug 28 '19 15:08 cdvillard

Sounds good to me @cdivillard, although I don’t know much about this. Curious, would we want to have stand-alone profile pages that someone could link to?

taurean avatar Aug 29 '19 09:08 taurean

I'd prefer to use as little JS as possible to make this as performant and accessible as possible. If we want to serve communities where internet is slow and folks rely on data, that will be the best way.

Re: standalone pages: Yes, I'd love this to serve as something that folks can link to in lieu of (or in addition to) a website. That reminds me, we should consider adding a slot for Sponsor links (Patreon, GitHub Sponsors, etc)

tatianamac avatar Sep 01 '19 00:09 tatianamac

I'm on board with serving as little JS as possible and sponsor links.

Ultimately what I'm suggesting is server-side rendering or rendering at a build step on a service like Netlify. That way all that is served is static files, no unnecessary JS on the page. I believe that's what my GraphQL suggestion would accomplish, though I admit I'm still learning about it a bit. I'm fine with doing the legwork on that to confirm.

On Sat, Aug 31, 2019, 8:25 PM Tatiana Mac [email protected] wrote:

I'd prefer to use as little JS as possible to make this as performant and accessible as possible. If we want to serve communities where internet is slow and folks rely on data, that will be the best way.

Re: standalone pages: Yes, I'd love this to serve as something that folks can link to in lieu of (or in addition to) a website. That reminds me, we should consider adding a slot for Sponsor links (Patreon, GitHub Sponsors, etc)

— You are receiving this because you commented. Reply to this email directly, view it on GitHub https://github.com/tatianamac/devsofcolour/issues/4?email_source=notifications&email_token=ABPV5ZWLXPNMGOJYG7JDEATQHMDX3A5CNFSM4IH7ZEV2YY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOD5TXVQQ#issuecomment-526875330, or mute the thread https://github.com/notifications/unsubscribe-auth/ABPV5ZQTTDAAAPS5BAFNWBLQHMDX3ANCNFSM4IH7ZEVQ .

cdvillard avatar Sep 01 '19 01:09 cdvillard

@tatianamac love the sponsor link idea.

How did we feel as a group with that codepen mockup thing I did? Should we keep tweaking that or should I do something in a similar style for standalone pages?

taurean avatar Sep 01 '19 03:09 taurean

Can you link the codepen mockup please?

BboyAkers avatar Sep 01 '19 20:09 BboyAkers

https://codepen.io/taurean/pen/eqJOVy

taurean avatar Sep 01 '19 21:09 taurean

I dig it! Sorry for the late response. I can get cracking on building out some stuff if we get some tasks labeled. What do we want to use for the frontend?

BboyAkers avatar Sep 09 '19 02:09 BboyAkers

Love it! I did a small remix on it. Mostly trying to make it more concise. I am trying not to get too precious about the design right now so we can reexamine it after we do some testing down the road.

https://codepen.io/tatianamac/pen/yLBKYaP?editors=1100

tatianamac avatar Sep 09 '19 19:09 tatianamac

@taurean, I'm digging the general style of your mockup as an aesthetic, but I agree with @tatianamac's point that this can be always be rehashed down the road.

That said, assuming the attention is turning back to architecture, it sounds like Eleventy will be the SSG of choice. Is there a consensus on that? If so, how should we handle data?

(Also, sorry if I'm sounding off too much. I'm into the project, still learning the etiquette of these sorts of greenfield open-source projects.)

cdvillard avatar Sep 09 '19 19:09 cdvillard

Ya'll want to hop on a slack/skype/discord call? If so email me at [email protected]

BboyAkers avatar Oct 03 '19 03:10 BboyAkers

Sorry—notifications have been turned off for me so I missed these messages!

I'd ideally like to use Eleventy for its performant nature (doesn't require JS out of box), data infrastructure, that it strips the end-rendered site of any Eleventy junk.

Data-wise, it seems like some way for people to modify a JSON file might be the best? Using a PR to add themselves? We can try to make this easier down the line, too, integrating Netlify forms or CMS to remove the need for someone to know how to use Git to contribute.

I'm open to other suggestions, but feel like Eleventy is the best option from my POV.

No worries on etiquette—directness is good. It reminds me I need to get a CoC going for this project as we add folks.

tatianamac avatar Oct 12 '19 13:10 tatianamac

@taurean Do you feel comfortable spinning something up?

tatianamac avatar Nov 13 '19 01:11 tatianamac

Whoops I just saw this and your last message. I can spin up something this weekend!

BboyAkers avatar Nov 14 '19 21:11 BboyAkers

@BboyAkers Thanks, Austin!

@taurean Are you still able to help with this project?

tatianamac avatar Nov 19 '19 22:11 tatianamac

TLDR; Yes

NTL,DR; finally back to work this week after recovering from surgery. My capacity for stuff like this should increase a lot more as I get caught up with everything. 😄

@BboyAkers I'm not super familiar with 11ty yet but I'm sure I can start contributing code once we have something simple going.

taurean avatar Nov 19 '19 22:11 taurean

Sounds good, @taurean. I hope your surgery went well.

@BboyAkers It may be of help to check out the other OSS project I'm working on, Self-Defined, as it's been set up with collections for words (instead of individuals). We may find the format helpful?

Here is an in-progress PR that features that format.

tatianamac avatar Nov 20 '19 15:11 tatianamac

Hey, it’s me, author of the linked PR. If any questions pop up, feel free to @ me :)

ovlb avatar Nov 20 '19 15:11 ovlb

Bumping this thread in 2020 :-)

Comp looks great!

I’d be happy to help get a first pass of Eleventy together if that’s the route we wanna go.

aarongustafson avatar Feb 27 '20 19:02 aarongustafson

@aarongustafson I say we get that started with what we discussed on DM!

tatianamac avatar Mar 03 '20 20:03 tatianamac

Sounds good. I'll look to carve out some time over the next week to do an initial pass.

aarongustafson avatar Mar 04 '20 15:03 aarongustafson

@aarongustafson I'm having issues getting the app to start after installing all the dependencies. If you've got some time to help troubleshoot, I'd appreciate it (I'm not much of a node developer)!

jjziv avatar Jun 03 '20 00:06 jjziv

didn't realize anything had been built yet, thanks @aarongustafson! @jjziv I just got it to run locally, maybe I can help. What issue are you facing, can you share the error?

taurean avatar Jun 03 '20 01:06 taurean

@taurean Thanks - I figured it out! My version of node wasn't new enough, so eleventy wasn't starting.

We should discuss approach via the Slack group so we can start splitting up tasks and assigning.

jjziv avatar Jun 03 '20 13:06 jjziv

what slack group? 👀

taurean avatar Jun 03 '20 13:06 taurean

@taurean Sorry, it only just occurred to me I could have folks working on this be on the Self-Defined slack too to help support each other. I'm very low on energy/time for these two projects these days, so having the support network has been amazing. (Both are built on Eleventy) https://join.slack.com/t/selfdefined/shared_invite/zt-en1u6xn8-CumcehUfprC0GH5lamb1bg

tatianamac avatar Jun 03 '20 17:06 tatianamac

I apologise for my delayed response. Between parental duties and my Mac going into a wicked boot/crash loop and needing to be rebuilt, I've gotten a bit behind in email & such. I'm glad this got sorted. I'll join the Slack too.

aarongustafson avatar Jun 10 '20 14:06 aarongustafson

Note to everyone I migrated this onto the /selfdefined org now.

tatianamac avatar Jun 12 '20 22:06 tatianamac