| 
1 | 1 | # TC39 website draft  | 
2 | 2 | 
 
  | 
3 |  | -The TC39 website aims to improve the web presence and host the documentation of the TC39. We want to  | 
 | 3 | +The TC39 website aims to improve the web presence and host the documentation of TC39. We want to  | 
4 | 4 | make the JavaScript spec more accessible and help people understand what the committee does!  | 
5 | 5 | 
 
  | 
6 |  | -This site is built using github pages and jekyll, and is currently in beta stage. We are looking for  | 
7 |  | -feedback from people of all areas to get feedback.  | 
 | 6 | +This site is built using GitHub Pages and Jekyll and is currently in beta. We are looking for  | 
 | 7 | +feedback from people of all areas.  | 
8 | 8 | 
 
  | 
9 | 9 |   | 
10 | 10 | 
 
  | 
11 | 11 | ## Getting involved  | 
12 | 12 | 
 
  | 
13 | 13 | This project adheres to the TC39 [Code of Conduct](https://tc39.github.io/code-of-conduct/).  | 
14 | 14 | 
 
  | 
15 |  | -If you find that you are not getting the information you need the page, please comment on our  | 
 | 15 | +### Issues  | 
 | 16 | + | 
 | 17 | +If you find that this website does not provide the information you need, please comment on our  | 
16 | 18 | [usability thread](https://github.com/tc39/tc39-web-draft/issues/41) with  | 
17 |  | -what you were looking for, and where you would have expected to find it! This kind of information  | 
 | 19 | +what you were looking for and where you would have expected to find it! This  | 
18 | 20 | helps us understand what people's needs are and how we can improve this page to address those needs.  | 
19 | 21 | 
 
  | 
20 |  | -If you notice an issue with the website itself, such as accessibility issues, or web compatibility  | 
21 |  | -issues, open a new issue and we will try to fix it!  | 
 | 22 | +If you notice a problem with the site itself, such as accessibility or web compatibility, open a new issue and we will try to fix it!  | 
22 | 23 | 
 
  | 
23 |  | -You can also take on issues and help us improve the site.  | 
 | 24 | +### Pull requests  | 
24 | 25 | 
 
  | 
25 |  | -Commits in pull requests should have a first line which starts with the issue number, followed by  | 
26 |  | -the change that was made. For example:  | 
 | 26 | +You can also take on issues and help us improve the site.  | 
27 | 27 | 
 
  | 
28 |  | -`fix #32, add a footer`  | 
 | 28 | +Pull request titles should start with the issue number being addressed, followed by  | 
 | 29 | +the change that was made. For example, `fix #32, add a footer`.  | 
29 | 30 | 
 
  | 
30 | 31 | If changes in the upstream master branch cause your PR to have conflicts, you should  | 
31 | 32 | rebase your branch to master and force-push it to your repo (rather than doing a  | 
32 | 33 | merge commit).  | 
33 | 34 | 
 
  | 
34 |  | -## Setting up your environment  | 
35 |  | -Building the website requires [Docker](https://docs.docker.com/install/) This allows you to have a dev environment set up with Ruby and Bundler already installed, along with all the depenencies this project needs.  | 
 | 35 | +## Local development  | 
 | 36 | + | 
 | 37 | +Building the website requires [Docker](https://docs.docker.com/install/). This gives you a dev environment with Ruby, Bundler, and all other project dependencies already installed.  | 
36 | 38 | 
 
  | 
37 |  | -Once installed you should be able to get set up by running  | 
38 |  | -`$ make install` - This will install all the Ruby dependencies plus the environment for you to run the site  | 
39 |  | -`$ make build` - This runs Jekyll, and rebuilds the site folder  | 
40 |  | -`$ make serve` - If you're developing this is a better option, as it will run Jekyll and watch for changes, this option also sets up a dev server on `localhost:8000`  | 
 | 39 | +After installing Docker and cloning this repo, you can build and serve the website as follows.  | 
 | 40 | +```bash  | 
 | 41 | +cd tc39-web-draft  | 
 | 42 | +make install      # install the site's Docker image  | 
 | 43 | +make build        # run Jekyll and rebuild site folder  | 
 | 44 | +make serve        # run Jekyll, serve site on localhost:8000, and watch for local changes  | 
 | 45 | +```  | 
41 | 46 | 
 
  | 
42 | 47 | ## Discussion  | 
43 | 48 | 
 
  | 
44 | 49 | We use IRC to communicate. The channel we use is #tc39-website on freenode. You can find  | 
45 |  | -instructions for how to get online [here](https://freenode.net/kb/answer/chat)  | 
 | 50 | +connection instructions [here](https://freenode.net/kb/answer/chat).  | 
0 commit comments