Skip to content

Commit

Permalink
chore: Merge content from nodejs/website-redesign (nodejs#270)
Browse files Browse the repository at this point in the history
  • Loading branch information
amiller-gh authored Jul 4, 2019
1 parent e4f5d30 commit da8278f
Show file tree
Hide file tree
Showing 22 changed files with 1,590 additions and 3 deletions.
17 changes: 14 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
# Making changes to nodejs.dev

## Vocabulary

* A **Contributor** is any individual creating or commenting on an issue or pull request,
or contributing in some other way.
* A **Collaborator** is a contributor who has been given write access to the repository.

## Commit Guidelines

This project follows the [Conventional Commits][] specification.
Expand All @@ -12,15 +18,15 @@ There is a built-in commit linter. Basic rules:

> build, chore, ci, docs, feat, fix, perf, refactor, revert, style, test
- Commit messages must start with a capital letter
- Commit messages must not end with a period `.`
- Commit messages **must** start with a capital letter
- Commit messages **must not** end with a period `.`

## Collaboration Policy

- All changes must come in a PR
- All changes must be reviewed by a member of @nodejs/nodejs.dev,
@nodejs/website, or @nodejs/website-redesign
- Pull Requests must be open for at least 24 hours unless included in the special exemptions section below
- Pull Requests must be open for at least 48 hours unless included in the special exemptions section below

### Special Exemptions

Expand All @@ -36,6 +42,11 @@ Pull requests seeking to make any of the following changes do not need to wait 2

- The Status Checks for the test suite must pass
- There must be at least one sign off
- There must be no objections after a 48 hour period

The default for each contribution is that it is accepted once no collaborator has an objection. During review collaborators may also request that a specific contributor who is most versed in a particular area gives a "LGTM" before the PR can be merged.

In the case of an objection being raised in a pull request by another collaborator, all involved collaborators should seek to arrive at a consensus by way of addressing concerns being expressed by discussion, compromise on the proposed change, or withdrawal of the proposed change.

## When Landing

Expand Down
125 changes: 125 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -122,3 +122,128 @@ Looking for more guidance? Full documentation for Gatsby lives [on the website](
- **For most developers, we recommend starting with our [in-depth tutorial for creating a site with Gatsby](https://next.gatsbyjs.org/tutorial/).** It starts with zero assumptions about your level of ability and walks through every step of the process.
- **To dive straight into code samples head [to our documentation](https://next.gatsbyjs.org/docs/).** In particular, check out the “Guides”, API reference, and “Advanced Tutorials” sections in the sidebar.
## 🏛 Governance
This initiative adopts the general Node.js [Code of Conduct][], as well as its
own [Contributing Guidelines][].
### Meetings
[Meeting notes][] from past meetings are maintained for later reference.
[Query issues for "Meeting"][] to find future meetings.
### Summary / Current Status
Our current focus is on site development. Development is happening in the [nodejs.dev repo](https://github.com/nodejs/nodejs.dev). This repo continues to be the hub for the redesign initiative.
### Team
**[@nodejs/website-redesign](https://github.com/nodejs/website-redesign)**
Any person who wants to contribute to the initiative is welcome! Please read
[Contributing Guidelines][] and join the effort 🙌.
Any member of the website-redesign initiative attached to the current phase of
the project will be added to a future phase as the project moves forward.
Any member of the website-redesign initiative who prefers to begin contributing
at a specific future phase is welcome to make a PR adding their handle to that
phase.
* [@amiller-gh](https://github.com/amiller-gh) - **Adam Miller**, CommComm
Co-champion
* [@chowdhurian](https://github.com/chowdhurian) - **Manil Chowdhury**, CommComm
Co-champion
#### Information Gathering
* [@amiller-gh](https://github.com/amiller-gh) - **Adam Miller**
* [@codeekage](https://github.com/codeekage) - **Agiri Abraham JNR**
* [@darcyclarke](https://github.com/darcyclarke) - **Darcy Clarke**
* [@maddhruv](https://github.com/maddhruv) - **Dhruv Jain**
* [@fhemberger](https://github.com/fhemberger) - **Frederic Hemberger**
* [@JonahMoses](https://github.com/JonahMoses) - **Jonah Moses**
* [@chowdhurian](https://github.com/chowdhurian) - **Manil Chowdhury**
* [@oe](https://github.com/oe) - **Olivia Hugger**
* [@bnb](https://github.com/bnb) - **Tierney Cyren**
* [@timothyis](https://github.com/timothyis) - **Timothy**
#### IA / UX Planning
* [@oe](https://github.com/oe) - **Olivia Hugger**
* [@fhemberger](https://github.com/fhemberger) - **Frederic Hemberger**
* [@bnb](https://github.com/bnb) - **Tierney Cyren**
* [@timothyis](https://github.com/timothyis) - **Timothy**
* [@JonahMoses](https://github.com/JonahMoses) - **Jonah Moses**
* [@amiller-gh](https://github.com/amiller-gh) - **Adam Miller**
* [@emilypmendez](https://github.com/emilypmendez) - **Emily Mendez**
* [@darcyclarke](https://github.com/darcyclarke) - **Darcy Clarke**
* [@maddhruv](https://github.com/maddhruv) - **Dhruv Jain**
* [@chowdhurian](https://github.com/chowdhurian) - **Manil Chowdhury**
* [@codeekage](https://github.com/codeekage) - **Agiri Abraham JNR**
* [@add1sun](https://github.com/add1sun) - **Addison Berry**
* [@Qard](https://github.com/Qard) - **Stephen Belanger**
* [@watilde](https://github.com/watilde) - **Daijiro Wachi**
* [@tolmasky](https://github.com/tolmasky) - **Francisco Ryan Tolmasky I**
* [@milapbhojak](https://github.com/milapbhojak) - **Milap Bhojak**
* [@devamaz](https://github.com/devamaz) - **Ahmad Abdul-Aziz**
#### UI Design and Content Creation
* [@amiller-gh](https://github.com/amiller-gh) - **Adam Miller**
* [@bnb](https://github.com/bnb) - **Tierney Cyren**
* [@codeekage](https://github.com/codeekage) - **Agiri Abraham JNR**
* [@chowdhurian](https://github.com/chowdhurian) - **Manil Chowdhury**
* [@maddhruv](https://github.com/maddhruv) - **Dhruv Jain**
* [@milapbhojak](https://github.com/milapbhojak) - **Milap Bhojak**
* [@tolmasky](https://github.com/tolmasky) - **Francisco Ryan Tolmasky I**
* [@iNidAName](https://github.com/inidaname) - **Hassaan Sani**
* [@abedzantout](https://github.com/abedzantout) - **Abdul Rahman Zantout**
* [@AliObaji](https://github.com/AliObaji) - **Ali Obaji**
* [@AhmadAwais](https://github.com/AhmadAwais) - **AhmadAwais**
#### Site Development _<-- current phase_
* [@abiclub23](https://github.com/abiclub23) - **Abhi Tondepu**
* [@ajay2507](https://github.com/ajay2507) - **Ajaykumar**
* [@connorholyday](https://github.com/connorholyday) - **Connor Holyday**
* [@iceagency-jakecruse](https://github.com/iceagency-jakecruse) - **Jake Cruse**
* [@iceagency-lukehopkins](https://github.com/iceagency-lukehopkins) - **Luke Hopkins**
* [@jestho](https://github.com/jestho) - **Jesper Thøgersen**
* [@jonahmoses](https://github.com/jonahmoses) - **Jonah Moses**
* [@sagirk](https://github.com/sagirk) - **Sagir Khan**
* [@ollelauribostrom](https://github.com/ollelauribostrom) - **Olle Lauri Boström**
* [@belar](https://github.com/Belar) - **Paweł**
* [@erichodges](https://github.com/erichodges) - **Eric Hodges**
* [@utkarshbhimte](https://github.com/utkarshbhimte) - **Utkarsh Bhimte**
* [@lidoravitan](https://github.com/lidoravitan) - **Lidor Avitan**
* [@mbj36](https://github.com/mbj36) - **Mohit Bajoria**
* [@zanmarolt](https://github.com/zanmarolt) - **Zan Marolt**
* [@imbhargav5](https://github.com/imbhargav5) - **Bhargav Ponnapalli**
* [@mikeattara](https://github.com/mikeattara) - **Mike Perry Y Attara**
* [@ZYSzys](https://github.com/ZYSzys) - **ZYSzys**
* [@mrjam2](https://github.com/mrjam2) - **Jamie Burton**
* [@jamesgeorge007](https://github.com/jamesgeorge007) - **James George**
* [@Yash-Handa](https://github.com/Yash-Handa) - **Yash Handa**
* [@iNidAName](https://github.com/inidaname) - **Hassaan Sani**
* [@abedzantout](https://github.com/abedzantout) - **Abdul Rahman Zantout**
* [@LaRuaNa](https://github.com/LaRuaNa) - **Onur Laru**
* [@AhmadAwais](https://github.com/AhmadAwais) - **AhmadAwais**
* [@BeniCheni](https://github.com/BeniCheni) - **Benjamin Chen**
* [@kevjin](https://github.com/kevjin) - **Kevin Jin**
## Links
[Community Committee][]
[Code of Conduct][]
[Contributing Guidelines][]
[Meeting Notes][]
[Query issues for "Meeting"][]
[community committee]: https://github.com/nodejs/community-committee
[code of conduct]: https://github.com/nodejs/admin/blob/master/CODE_OF_CONDUCT.md
[contributing guidelines]: ./CONTRIBUTING.md
[meeting notes]: ./meetings
[query issues for "meeting"]: https://github.com/nodejs/website-redesign/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+Meeting+in%3Atitle
110 changes: 110 additions & 0 deletions meetings/2018-02-01.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,110 @@
# Node.js Foundation Website Redesign Initiative Meeting 2018-02-01

## Present
- @oe
- @bnb
- @chowdhurian
- @fhemberger
- @amiller-gh
- @maddhruv
- @timothyis
- @franciscop
- @mrhinkle

## Notes

- Prioritizing agenda

### General objectives, strategy going forward

- Olivia, Tierney: We should ensure that goals are long-term
- Adam: Rediscussing the points listed in https://github.com/nodejs/nodejs.org/issues/1534
- Adam: Site Structure, Design, Implementation
- Adam: In that order
- Olivia: Previous discussions have been too implementation-focused

- Olivia: before we get down the agenda, what cadence do we want the meetings to be on
- General agreement: every 2 weeks

### Overall site structure

- See also https://github.com/nodejs/nodejs.org/issues/1534 (Assess current site structure, see what's needed and what's not).

- Frederic: History of website. There never was a well defined content structure, it was made as needed.
- Jeremiah: brief notes on iojs.org’s design
- Adam: sounds like now’s a good time to do something more design focused
- Tierney: an overview of some obstacles on the current website
- Olivia: Make it easier to add information in a more structured manner.
- Adam: Also a good opportunity to have a design-focused process for contribution review
- Adam: Process for PR to add content to site, would help the different stakeholders who add content to site.
- Olivia: Suggestion to start. What do we have now, a sort of site map. Then go from there.
- Frederic: volunteers to write up a site map of the existing site (link)
- Tierney, Jeremiah: discussion of how the node api docs are maintained somewhat separate.
- Adam: Overview of his blog post write up which compares to other “competeting” websites in some detail: https://medium.com/the-node-js-collection/redesigning-nodejs-part-1-fac08a0e015a
- Fransisco: what are the main goals of the current website?
- Tierney: Primary uses of site to date: Downloads, information, Documentation, Getting involved.

### Addressing content held in separate repositories

- Olivia: How should we address documents in separate repositories?
- Frederic: I want to see the Code of Conduct, governance docs, etc, directly. Should be part of the website.
- Adam: I’d love to see some “Learn” page, a normal-language guided tour. Something more comprehensive and ergonomic.
- Adam: We may not need to write this content as it may already exist and we may be able to get it contributed back.
- Frederic: The getting started guides are currently at https://nodejs.org/en/docs/guides/getting-started-guide/, needs to be surfaced better. As does the introduction https://nodejs.org/en/about/.
- Adam: The site should feel more cohesive.
- Timothy: I don’t really agree - have seen other examples where the docs and main site work for different purposes.
- Adam: Some things should probably look the same as the home page, e.g. the ‘getting started’.
- Adam: So long as implementation doesn’t impact design

### Syncing with the Node.js Foundation website

- Frederic: Let’s also think about the foundation website: They have a wordpress setup right now, but at the moment the foundation website looks totally different. (There could be a technical solution to keep the WP theme with the website layout in sync.)
- Olivia: We might need to figure that out as we go, we’ll need to stay in contact with the people who manage the foundation website.
- Tierney: We should avoid duplicating too much content between Foundation and Node.js website.
- Adam: Let’s invite the foundation site maintainers to these meetings.
- Adam: As for unifying theming and branding - I don’t think it is unreasonable to come from the design with a full process for theming Node.js branded websites.

### Decision structure (consensus, etc.)

- There is a Foundation marketing committee. Check with Greg ([email protected])
- Tierney: I sit on that committee as part of my job, and it is a pretty open group.

- Discussion of existing consensus-seeking model, seems acceptable (lazy consensus).

### Missing requirements

- Adam: documentation versions switcher (external)
- Adam: Better release structure overview (LTS schedule, etc)
- Adam: Robust community page
- Adam: Present the blog better
- Olivia: Is there a way we can consolidate the medium blog into the website when the time comes?
- Adam: I think there needs to be a strong distinction between community content and official (changelog, etc) content. I think these should stay separate.
- Split news into blog and release notes (and remove them from the regular blog)?

- Some other related discussion

- Francisco: Hard to search the docs.
- Tierney: We should probably try to get a little higher level than the content in this planning.
- Timothy: We probably need a collection of higher-level content needs, what general site functionality is required.

### Previous attempts at redesigning the website

- Frederic: Two previous attempts
- Frederic: One was from Leo, but had no content/structure discussion, just design/mockups.
- Frederic: The other time was something from the foundation, but never came to anything.
- Frederic: Was poor communication with the foundation there.
- Olivia: Neither really came from the community itself…
- Tierney: Both were a single point of failure, didn’t have enough time and ultimately dropped it.
- Timothy: It is clear we need to remember this is a really big challenge, we need to break it down into manageable chunks.
- Olivia: We could actually hire a designer with foundation funds if necessary...
- Mark: (Some discussion on how hiring someone would work between the foundation.)

- Some discussion of previous design competitions e.g. the logo (mixed results regarding brand experience, overall design, etc.)

- Olivia: Any other questions before we end?
- Adam: If we have the ability to hire, are we able to do lower-level brand design e.g. the logo if necessary/desired?

- Francisco: Should we estimate a timeline? Is getting a designer even possible this year?
- Mark: (Some clarification of funds allocation.)
- Olivia: As to general timeline… good question. Hard to pinpoint down at this point.
- Jeremiah: No less than 6 months.
52 changes: 52 additions & 0 deletions meetings/2018-02-15.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
# Node.js Foundation Website Redesign Initiative Meeting 2018-02-15

## Present
* Olivia Hugger
* Tierney Cyren
* Adam Miller
* Manil Chowdhury
* Frederic Hemberger
* Jeremiah Senkpiel
* Emily Mendez

## Notes
Order in the agenda will be rearranged to prioritize issues

### Overall site structure #4

* group discussed overall structure proposed by Adam, no objections were raised
* wireframe the suggestions and share to github
* TODO: Set up balsamiq and get a GDoc configured with it
https://chrome.google.com/webstore/detail/balsamiq-wireframes-for-d/jmebhflpaooegildgjfecegknjahhfki?hl=en
* Sub-sites of nodejs.org


### Getting started section #9

* Nodejitsu handed over their Knowledge Base, it’s not linked on the website yet.
* Needs to be reviewed, probably outdated but could be a good starting point.
* This will be a longer-term, content-heavy effort that will be a WIP well beyond the redesign launch
* Reach out to NodeSchool, regarding Getting Started content
* Should include multiple approaches to getting started, i.e. web app, FaaS, CLI, etc.
* TODO: Investigate how frameworks and languages implement interactive Getting Started experiences

### Updating Node.js messaging #242 (in CommComm)
* Also discussed in nodejs.org/#1534:
Examples:
- http://styleguide.mailchimp.com

- http://voiceandtone.com
* messaging is old and may have been outgrown
* Existing content in Evangelism repo: Social Media Style Guide
* Must make sure to collaborate with the Foundation to make sure of buy in

### Components library #5
* Paused till future when architecture etc has been determined

### Timeline

* Timeboxing can be demotivating
* Suggested approach: At the beginning of each section (eg. Architecture), estimate how long it’ll take, surface in the meeting, update as needed

## Timeline Review:
* 2 week deliverables (architecture phase ongoing): real content for Learning, detailed wireframe

Loading

0 comments on commit da8278f

Please sign in to comment.