Skip to content
This repository was archived by the owner on Apr 26, 2024. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 0 additions & 10 deletions .remarkrc
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,8 @@
"plugins": [
"remark-frontmatter",
"remark-preset-lint-node",
["remark-lint-code-block-style", false],
["remark-lint-fenced-code-flag", false],
["remark-lint-first-heading-level", false],
["remark-lint-list-item-bullet-indent", false],
["remark-lint-list-item-indent", false],
["remark-lint-maximum-line-length", false],
["remark-lint-no-consecutive-blank-lines", false],
["remark-lint-no-inline-padding", false],
["remark-lint-no-multiple-toplevel-headings", false],
["remark-lint-no-shortcut-reference-link", false],
["remark-lint-no-trailing-spaces", false],
["remark-lint-no-undefined-references", false],
["remark-lint-unordered-list-marker-style", false]
]
}
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Pull requests seeking to make any of the following changes do not need to wait 2
- 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.
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.

Expand Down
83 changes: 42 additions & 41 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,11 +26,11 @@

## 🚀 Get Started

1. **Install Yarn (if Yarn Package Manager is not available on your machine).**
1. **Install Yarn (if Yarn Package Manager is not available on your machine).**

Yarn has an [installation guide](https://yarnpkg.com/en/docs/install) for your specific configuration. Happy knitting!

2. **Install dependencies.**
2. **Install dependencies.**

```sh
# install the dependencies
Expand All @@ -44,7 +44,7 @@
yarn start
```

4. **Open the source code and start editing!**
4. **Open the source code and start editing!**

Your site is now running at `http://localhost:8000`!

Expand All @@ -54,58 +54,60 @@

A quick look at the top-level files and directories you'll see in a Gatsby project.

.
├── node_modules
├── src
├── .gitignore
├── .nvmrc
├── .prettierrc
├── empty.env
├── gatsby-browser.js
├── gatsby-config.js
├── gatsby-node.js
├── gatsby-ssr.js
├── LICENSE
├── package-lock.json
├── package.json
├── README.md
├── tsconfig.json
├── tslint.json
└── yarn.lock
```console
.
├── node_modules
├── src
├── .gitignore
├── .nvmrc
├── .prettierrc
├── empty.env
├── gatsby-browser.js
├── gatsby-config.js
├── gatsby-node.js
├── gatsby-ssr.js
├── LICENSE
├── package-lock.json
├── package.json
├── README.md
├── tsconfig.json
├── tslint.json
└── yarn.lock
```

1. **`/node_modules`**: The directory where all of the modules of code that your project depends on (npm packages) are automatically installed.
1. **`/node_modules`**: The directory where all of the modules of code that your project depends on (npm packages) are automatically installed.

2. **`/src`**: This directory will contain all of the code related to what you will see on the front-end of your site (what you see in the browser), like your site header, or a page template. “Src” is a convention for “source code.”
2. **`/src`**: This directory will contain all of the code related to what you will see on the front-end of your site (what you see in the browser), like your site header, or a page template. “Src” is a convention for “source code.”

3. **`.gitignore`**: This file tells git which files it should not track/not maintain a version history.
3. **`.gitignore`**: This file tells git which files it should not track/not maintain a version history.

4. **`.nvmrc`**: NVM configuration so packages work as they should
4. **`.nvmrc`**: NVM configuration so packages work as they should

5. **`.prettierrc`**: This is a configuration file for a tool called [Prettier](https://prettier.io/), which is a tool to help keep the formatting of your code consistent.
5. **`.prettierrc`**: This is a configuration file for a tool called [Prettier](https://prettier.io/), which is a tool to help keep the formatting of your code consistent.

6. **`empty.env`**: Rename to **`.env`** and set your Contentful API key
6. **`empty.env`**: Rename to **`.env`** and set your Contentful API key

7. **`gatsby-browser.tsx`**: This file is where Gatsby expects to find any usage of the [Gatsby browser APIs](https://next.gatsbyjs.org/docs/browser-apis/) (if any). These allow customization/extension of default Gatsby settings affecting the browser.
7. **`gatsby-browser.tsx`**: This file is where Gatsby expects to find any usage of the [Gatsby browser APIs](https://next.gatsbyjs.org/docs/browser-apis/) (if any). These allow customization/extension of default Gatsby settings affecting the browser.

6. **`gatsby-config.js`**: This is the main configuration file for a Gatsby site. This is where you can specify information about your site (metadata) like the site title and description, which Gatsby plugins you’d like to include, etc. (Check out the [config docs](https://next.gatsbyjs.org/docs/gatsby-config/) for more detail).
6. **`gatsby-config.js`**: This is the main configuration file for a Gatsby site. This is where you can specify information about your site (metadata) like the site title and description, which Gatsby plugins you’d like to include, etc. (Check out the [config docs](https://next.gatsbyjs.org/docs/gatsby-config/) for more detail).

8. **`gatsby-node.js`**: This file is where Gatsby expects to find any usage of the [Gatsby node APIs](https://next.gatsbyjs.org/docs/node-apis/) (if any). These allow customization/extension of default Gatsby settings affecting pieces of the site build process.
8. **`gatsby-node.js`**: This file is where Gatsby expects to find any usage of the [Gatsby node APIs](https://next.gatsbyjs.org/docs/node-apis/) (if any). These allow customization/extension of default Gatsby settings affecting pieces of the site build process.

9. **`gatsby-ssr.tsx`**: This file is where Gatsby expects to find any usage of the [Gatsby server-side rendering APIs](https://next.gatsbyjs.org/docs/ssr-apis/) (if any). These allow customization of default Gatsby settings affecting server-side rendering.
9. **`gatsby-ssr.tsx`**: This file is where Gatsby expects to find any usage of the [Gatsby server-side rendering APIs](https://next.gatsbyjs.org/docs/ssr-apis/) (if any). These allow customization of default Gatsby settings affecting server-side rendering.

10. **`LICENSE`**: Gatsby is licensed under the MIT license.
10. **`LICENSE`**: Gatsby is licensed under the MIT license.

11. **`package-lock.json`** (See `package.json` below, first). This is an automatically generated file based on the exact versions of your npm dependencies that were installed for your project. (You won’t change this file directly).
11. **`package-lock.json`** (See `package.json` below, first). This is an automatically generated file based on the exact versions of your npm dependencies that were installed for your project. (You won’t change this file directly).

12. **`package.json`**: A manifest file for Node.js projects, which includes things like metadata (the project’s name, author, etc.). This manifest is how npm knows which packages to install for your project.
12. **`package.json`**: A manifest file for Node.js projects, which includes things like metadata (the project’s name, author, etc.). This manifest is how npm knows which packages to install for your project.

13. **`README.md`**: A text file containing useful reference information about your project.
13. **`README.md`**: A text file containing useful reference information about your project.

14. **`tsconfig.json`**: Config file for TypeScript
14. **`tsconfig.json`**: Config file for TypeScript

15. **`tslint.json`**: TS Lint configuration file
15. **`tslint.json`**: TS Lint configuration file

16. **`yarn.lock`**: [Yarn](https://yarnpkg.com/) is a package manager alternative to npm. You can use either yarn or npm, though all of the Gatsby docs reference npm. This file serves essentially the same purpose as `package-lock.json`, just for a different package management system.
16. **`yarn.lock`**: [Yarn](https://yarnpkg.com/) is a package manager alternative to npm. You can use either yarn or npm, though all of the Gatsby docs reference npm. This file serves essentially the same purpose as `package-lock.json`, just for a different package management system.

## 📝 Data Sources

Expand All @@ -119,10 +121,9 @@ The `src/documentation` directory currently contains all the getting started con

Looking for more guidance? Full documentation for Gatsby lives [on the website](https://next.gatsbyjs.org/). Here are some places to start:

- **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.
- **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

Expand Down
6 changes: 2 additions & 4 deletions meetings/2018-02-15.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@ Order in the agenda will be rearranged to prioritize issues
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.
Expand All @@ -33,8 +32,8 @@ https://chrome.google.com/webstore/detail/balsamiq-wireframes-for-d/jmebhflpaooe
### Updating Node.js messaging #242 (in CommComm)
* Also discussed in nodejs.org/#1534:
Examples:
- http://styleguide.mailchimp.com
- http://voiceandtone.com
- 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
Expand All @@ -49,4 +48,3 @@ https://chrome.google.com/webstore/detail/balsamiq-wireframes-for-d/jmebhflpaooe

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

10 changes: 1 addition & 9 deletions meetings/2018-03-01.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,14 +14,13 @@ Order in the agenda will be rearranged to prioritize issues

### Website Wireframes [#15](https://github.com/nodejs/website-redesign/issues/15)
Context: We left the last meeting with an action item to have wireframes for discussion by next discussion. Adam makes first pass and put it together. Much activity, we notice visuals helps increase engagement. There are a lot of outstanding questions. Intent is broad strokes for site flow.
* Suggest prioritizing content.
* Suggest prioritizing content.
* The largest point of discussion was how the download button works in the home page. Maybe set up three options and ask for feedback.
* Analytics: There are analytics for the nodejs org site. We don’t have access but we can request from Zibby Keaton. Caution against putting too much stock in that instead of doing enough user exploration.
* Goals: Clear navigation hierarchy that surfaces everything. Restructuring the current website that has several years of tacked on additions.
* Content: Would want more content for this on Getting Started.
* TODO: Open up a user personas issue.


### Voice and Tone Guidelines [#13](https://github.com/nodejs/website-redesign/issues/13)
* Prepare the document as if it could be used beyond the scope but the scope is unchanged.
* TODO: Make clear in the doc, the use of humour and recommended voice for that.
Expand All @@ -41,31 +40,24 @@ Context: Console/editor with which to test the capabilities of node.
* Runkit: you don’t see package files which is arguably better for tutorials
* The objective: We need to identify the feature set that best satisfies the needs of the code playground.


### Getting started section [#9](https://github.com/nodejs/website-redesign/issues/9)
* Past TODO: Investigate how frameworks and languages implement interactive Getting Started experiences
* The purpose: onboard people on getting running from scratch. We should add more detailed getting started docs.
* Suggest a learning path doc. A suggested path, where if completed someone will know how to use nodejs and start on more custom things.
* Is there a way within Getting Started to tie into NodeSchool and other community initiatives? For this, the workshoppers need to be updated (some are Node 4). These would need an official maintainer to ensure they’re up to date.
* TODO: open a new issue to explore connecting to NodeSchool on Getting Started


### Updating Node.js messaging [#242](https://github.com/nodejs/community-committee/issues/242) (in CommComm)
* It’s good for a technical person coming to Nodejs for the first time, but not for other people. Focus on this for content building rather than in the content definition space.
* Open an issue for this in /admin because it’s a huge org wide scope.


### Overall site structure [#4](https://github.com/nodejs/website-redesign/issues/4)
* past TODO: Set up balsamiq and get a GDoc configured with it


### Notes
* Can start iterating on parts of the site where significant discussion has been had.
* TODO: Make doodle for new meeting time. Until then, meeting time remains the same


## Timeline Review:
* Suggested approach from earlier meeting: At the beginning of each section (eg. Architecture), estimate how long it’ll take, surface in the meeting, update as needed
* 2018-02-15: 2 week deliverables (architecture phase ongoing): real content for Learning, detailed wireframe


10 changes: 4 additions & 6 deletions meetings/2018-03-15.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@
#### Getting started with node [#9](https://github.com/nodejs/website-redesign/issues/9)
* Some of this could actually go into Learn section
* For the embedded runtime: What do we want?
* We want people to be able to jump in and use it without having the install dependencies
* We want to build up from JS knowledge and take users into using Node
* We want people to be able to jump in and use it without having the install dependencies
* We want to build up from JS knowledge and take users into using Node
* Do we want to also guide through Express or just explain Node core? The power of Node is the ecosystem and we should strike a balance. Take a look at how NodeSchool separates Core workshoppers from Electives.

TODO Tierney: Organize another meeting between NodeSchool and the Website Redesign Initiative
Expand All @@ -27,9 +27,7 @@ TODO Tierney: Organize another meeting between NodeSchool and the Website Redesi

## Q&A, Other

####

#### IA Document Summary
#### IA Document Summary
- Wireframes
- Content Graph
- Analytics
Expand All @@ -46,7 +44,7 @@ TODO Tierney: Organize another meeting between NodeSchool and the Website Redesi
- Minimal branding
- Maintained
- Cost
- Stdout / Console
- Stdout / Console

## Upcoming Meetings

Expand Down
1 change: 0 additions & 1 deletion meetings/2018-03-29.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,4 +58,3 @@
* **Node.js Foundation Calendar**: https://nodejs.org/calendar

Click `+GoogleCalendar` at the bottom right to add to your own Google calendar.

1 change: 0 additions & 1 deletion meetings/2018-04-12.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,4 +64,3 @@ Welcome @codeekage to the team! Happy to have you!
* **Node.js Foundation Calendar**: https://nodejs.org/calendar

Click `+GoogleCalendar` at the bottom right to add to your own Google calendar.

21 changes: 10 additions & 11 deletions meetings/2018-05-10.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,12 @@

* Website Redesign Strategic Initiative Team: @nodejs/website-redesign

- Tierney Cyren (@bnb)
- Adam Miller (@amiller-gh)
- Dhruv Jain (@maddhruv)
- Agiri Abraham Jr (@codeekage)
- Manil (@chowdhurian)
- Mark Hinkle
- Tierney Cyren (@bnb)
- Adam Miller (@amiller-gh)
- Dhruv Jain (@maddhruv)
- Agiri Abraham Jr (@codeekage)
- Manil (@chowdhurian)
- Mark Hinkle

## Agenda

Expand All @@ -33,7 +33,7 @@

* Website Wireframes [#15](https://github.com/nodejs/website-redesign/issues/15)
Removed from agenda, since we’ve moved on to Design
* Tech Exploration for In-Browser Node Playground
* Tech Exploration for In-Browser Node Playground
[#12](https://github.com/nodejs/website-redesign/issues/12)
Removed from Agenda, since we’ve moved on to design
* Extended Color Palette [#42](https://github.com/nodejs/website-redesign/issues/42)
Expand All @@ -46,14 +46,14 @@ What do you think of the extended color palette solution as a whole? I love hear
- Ask to join marketing team meeting
- Doesn’t look like it will conflict with existing brand

Dhruv: Do we fork existing libraries and keep it in Node.js so we have more control over design features?
Dhruv: Do we fork existing libraries and keep it in Node.js so we have more control over design features?
Adam / Tierney: We want to minimize support costs! Where possible, lets point out to OSS we’re leveraging and calling “standard” to reduce our maintenance burdon.

* Identify topics to discuss for Collab Summit Spring 2018 [#29](https://github.com/nodejs/website-redesign/issues/29)

Francisco: Parallel bug to getting started content – what is the getting started experience? What are priorities of “getting started” and docs?

Tierney: Good place to coordinate with TSC and other members across org about how to maintain docs.
Tierney: Good place to coordinate with TSC and other members across org about how to maintain docs.

- Intend to make docs more accessible
- Developing user personas could support the case of making the docs more readable and accessible
Expand All @@ -63,7 +63,7 @@ Tierney: Good place to coordinate with TSC and other members across org about ho
Agreed to push 1hr back to not torture our USA West Coast members

* Corporate Design Resource Donations
Tierney: Raised the possibility of soliciting designer resource donations from corporate foundation members.
Tierney: Raised the possibility of soliciting designer resource donations from corporate foundation members.
Francisco: Stripe may be interested in providing these resources as well, on a well-defined timeline. Will talk with leads today and report back.
Adam: This WG should function, among other things, as a design management body so as we have resources rotate in and out we still have a cohesive and unified project direction – we will happily take any resources we can get! There is always work :)

Expand All @@ -74,4 +74,3 @@ Adam: This WG should function, among other things, as a design management body s
* **Node.js Foundation Calendar**: https://nodejs.org/calendar

Click `+GoogleCalendar` at the bottom right to add to your own Google calendar.

Loading