Skip to content

New site structure #103

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 35 commits into from
Dec 19, 2018
Merged

New site structure #103

merged 35 commits into from
Dec 19, 2018

Conversation

terichadbourne
Copy link
Member

@terichadbourne terichadbourne commented Dec 14, 2018

(when finished) closes #51, closes #109 & partially addresses #102

@mikeal This is still very much a work in progress, particularly in regards to layout, but I think it now has the bulk of the content we've discussed and is at a place where we should start talking about what's missing or not as intended before I start making finer adjustments to the layout.

Some things I specifically want to improve before we merge and launch 1.0:

  • Center content (I understand why we should limit width of text blocks, but personally hate having narrower content make the right side of the screen empty)
  • Improve formatting of chapter listings (this is a proof of concept that we can pull from the JSON file and alphabetize)
  • Nicer formatting for chapters list
  • Add featured workshops (at present, all the ones that exist) to the homepage - I'm thinking this is probably just the title and description and then links to an anchor tag on the workshops page where they'd see the lessons that make up the workshop
  • Nicer formatting for button-ish links on home page, as noted there

Some things I want to improve that can probably wait until later:

Questions:

  • It looks like we're asking organizers to provide a lot of info in that JSON file that we're never displaying. Would you ever want to see more than the chapter location on our "Chapters" page, or are they responsible for surfacing stuff like who the organizers are, their Twitter handles, etc. on their own pages? (Currently the site is linking to a website if provided, otherwise the GH repo if provided, otherwise not generating a link.)
  • I find the relationship between chapters and events very ill-defined on the NodeSchool website and have tried to counter that a bit here but don't know to what degree I've succeeded. Is it assumed that organizing and chapter and hosting events go hand-in-hand, and you won't do one without doing the other? How do you feel about the way these concepts are currently presented here?
  • I'm debating relabelling the thing we've been calling a "workshop" to be called a "tutorial" instead, since workshop has a bit of an in-person event connotation. Thoughts?
  • Do we want a footer? If so, what's essential to have there?
  • What should we add to the Community Events section of the homepage, given that we have no events and have decided not to list them regardless.
  • What are we using as a CoC? I'm guessing this needs to be something new which mirrors the NodeSchool CoC as opposed to mirroring the IPFS community CoC?
  • I've added a bunch of dummy chapter data so I could proof to myself that I could loop through it and print the right stuff to the page, but in actuality all we have is a single San Francisco chapter with an essentially empty repo and no live site. Do you know specific folks within PL I should reach out to to ask if they'd like to organize a chapter so we can have a more impressive list at launch? (I looked at all those IPFS meetups within our pro account and discovered most are pretty much dead. I don't see obvious ones with regular content, but they may exist and not be associated with that account.)

- Add `workshops` route and create a new component for it
- Currently the contents of `home` and `workshop` routes are identical,
but `home` will now be edited to include the other site sections needed
- Create separate `header` component, called from both `home` and
`workshops`
- Remove non-header contents from `home` for now
- Update `workhops` to insert `header` component and then keep all
remaining workhsop content
- Update style sections of each workshop to remove unneeded styles
- Fix trailing commas
= Remove an empty `data` object in `home`
- Add nav bar to `header` component with working links to `home` and
`workshop` pages
- TODO: Make link disappear if it's to a page you're already viewing
- TODO: Make it pretty
- TODO: Prevent apparent shift when you go to workshop page and the
aqua area gets bigger
- Update formatting for nav links in `header`
- Remove top boarder from top section in `workshops` so the size of the
aqua area won't increase on page change
- Address various linter errors in Lesson.vue and ExerciseLink.vue
- Add `chapters` component with its own route
- Add dummy content to `home` and `chapters` components
- Add `chapters.json` file
- Require that file from `chapters.vue` and make a `chapters` property
that is an array of chapter objects
- Loop through chapter locations to print to chapters page
- Move images to an images folder
- Move `chapters.json` and `Chapters.vue` to a new `components/chapters`
folder
- Move `Workshops.vue` and `ExerciseLink.vue` to a new
`components/workshops`
folder
- Move `Header.vue` to `components` directory
- Move all images to new `images` directory and update images links in
other files
- Update `main.js` with new file structure where needed
- Replace favicon so it's the ProtoSchool logo rather than the IPFS logo
- Add more dummy data in `chapters.json`
- In `Chapters.vue` add `regions` computed property that returns an
array of regions sorted alphabetically
- In `Chapters.vue` add `chaptersByRegion` which returns an array objects
in which each object has a key which is a region name and a value which
is an array of chapter objects
- In `Chapters.vue` html, loop through regions and print chapter listings
for each, including a link to the website (if provided, otherwise repo,
if provided, otherwise no link)
- Add `host` page with corresponding route
- Add to text on `chapter` page and link to `host` page
- Update `main.js` with new route
- Update some import statements across components
- Link to homepage from logo in header
- Add `Build` component and update routes and navigation as needed
- Update `Host` page content to clarify what a chapter is and mention
other ways to contribute
- Add 'about' page and associated routes and nav options
- Add rough copy to homepage
- Add notes for future improvements
@mikeal
Copy link
Member

mikeal commented Dec 17, 2018

I didn't have time to read all the copy but the structure looks good. A few replies to your comments above:

It looks like we're asking organizers to provide a lot of info in that JSON file that we're never displaying. Would you ever want to see more than the chapter location

We could shorten this info a lot. The website and repo we can generate with just the "shortname" (san-francisco) and we could compress the location information into a single field instead of having another field for the country. I don't think we need the organizers either, we should have them maintain that themselves on their repo README's.

I find the relationship between chapters and events very ill-defined on the NodeSchool website and have tried to counter that a bit here but don't know to what degree I've succeeded. Is it assumed that organizing and chapter and hosting events go hand-in-hand, and you won't do one without doing the other? How do you feel about the way these concepts are currently presented here?

The main purpose of a chapter is to run in-person events, so we can assume that if there is a chapter they are running events or on some kind of hiatus.

However, we don't know when their next event will be, and I don't think it's really that useful for us to put that on the main site. In practice, you can only attend one that you're near, and so you'll want to visit their site or repo where we should be encouraging them to always note upcoming events.

I'm debating relabelling the thing we've been calling a "workshop" to be called a "tutorial" instead, since workshop has a bit of an in-person event connotation. Thoughts?

+1

Do we want a footer? If so, what's essential to have there?

If we don't have anything pressing to put in it I don't think we should add one :)

What should we add to the Community Events section of the homepage, given that we have no events and have decided not to list them regardless.

Let's compress this down into a single path where we try to pair a site visitor with the closest chapters and make it clear they run in-person events, rather than thinking of "Events" and "Chapters" as two flows.

What are we using as a CoC? I'm guessing this needs to be something new which mirrors the NodeSchool CoC as opposed to mirroring the IPFS community CoC?

Correct. We should use probably use the Conf Code of Conduct. CoC's for in-person events are bit different than open source projects so it makes sense to diverge from the IPFS CoC in this case.

Do you know specific folks within PL I should reach out to to ask if they'd like to organize a chapter so we can have a more impressive list at launch? (I looked at all those IPFS meetups within our pro account and discovered most are pretty much dead. I don't see obvious ones with regular content, but they may exist and not be associated with that account.)

Let's test the chapter sign-up flow inside of Protocol Labs in order to populate this. Once we've committed this PR let's send an email to the "shipped" mailing list asking for interested people to sign-up for a chapter.

- Remove potential chapter/event list from homepage
- Edit site content to use the word "tutorial" instead of "workshop" to
describe our online educational content (done to avoid confusion with
the live, in-person event connotation of the term workshop)
- Rename "About" to "Community" in components, nav bar, and routes
- Rename "Community" to "Contribute" in components, nav and router
- Failed attempt to center all content on Contribute page
- Center the main section on each page except "Workshops", with text
left-aligned inside the centered section
- Edit tagline to be about decentralized web, not IPFS
- Left justify header contents within a centered section matching other
page contents
- Update Code of Conduct section on Contributing page
- Center content in Workshops.vue (Tutorials page) to match rest of site
- Add featured tutorial tiles to homepage
- TODO: Add a project-specific logo or label to each
- Create buttons for the links to other pages
- Apply pill button formatting for chapter links on Chapters page
- On workshop page, improve tutorial title link formatting
@terichadbourne
Copy link
Member Author

@mikeal Could you please take another look and this and confirm you're okay with me merging? I'll fix the data before I merge (remove third tutorial from homepage if that lesson isn't merged yet and remove fake chapters), but I want you to see the formatting in the more populated version first.

@olizilla If you happen to have a chance to give this a quick look from a layout perspective, that would be great. I may need to kick minor stuff down the road, but I'd love to hear about anything that jumps out at you.

@mikeal
Copy link
Member

mikeal commented Dec 19, 2018

LGTM :)

- Update GitHub issue templates and references and links across
site to refer to "tutorials" in place of "workshops"
- Add new Navigation component with links array which checks
whether the path of each link matches the current route path and
changes the formatting accordingly, making it more obvious to the user
which page they're visiting
- Rename `workshops` directory to `tutorials` and `Workshops.vue` to
`Tutorials.vue`
- Update router links, component imports, and various text accordingly
@terichadbourne terichadbourne merged commit 3fcdcc0 into code Dec 19, 2018
@terichadbourne terichadbourne deleted the site-structure branch January 16, 2019 17:15
@Frijol Frijol mentioned this pull request Feb 23, 2019
@terichadbourne terichadbourne changed the title WIP: New site structure New site structure Mar 24, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Highlight nav component you're currently visiting Redesign site to include chapters, event listings, organizer tips
3 participants