Merge pull request #87 from Joe-Brady/repo-change

Update gitignore - dist dir and .html now ignored
AdoptOpenJDK · May 3, 2017 · b90f3fa · b90f3fa
2 parents 9a36987 + 5068351
commit b90f3fa
Show file tree

Hide file tree

Showing 36 changed files with 6 additions and 3,037 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,5 @@
 node_modules
 npm-debug.log
 .idea
+dist
+*.html
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -14,24 +14,22 @@
     npm install
     ```
 
-3. Start the auto-build scripts
+3. Start the auto-build scripts, and leave them running
 
     ```
     npm start
     ```
 
-4. Make changes **only** in the `/src` directory
-    > Please note that `api.js` is an exception to this rule: it appears only in `/dist`, and should be edited there.
+    > NOTE: These build scripts enable you to view your changes locally. The build generates new files in two places: a new `/dist` directory (JS, CSS, images, etc), and `.html` files in the root directory. However, these files are ignored by .gitignore, and will not be included in commits.
 
-5. Open `/index.html` in any browser, and refresh the page after saving your changes to `/src`.
+4. Make changes in the `/src` directory. The auto-build scripts instantly pick up any newly saved changes, and include them in the output files and directories. Open `/index.html` in any browser to view the website locally, and refresh the page after saving your changes to `/src`.
 
 ---
 
 ## Contribution guidelines
 
 ### HTML (Handlebars) pt.1
-* **Do not** edit the `.html` files in the root directory. They are created and updated by the build process.
-* Instead, edit the `.handlebars` files in the `/src/handlebars` directory.
+* Edit the `.handlebars` files in the `/src/handlebars` directory. These are built into HTML.
 * 'Handlebars' files should only include the `<main>` element, containing the page's content, and `{{> header}}` / `{{> footer }}` tags.
 
 ### HTML (Handlebars) pt.2 (creating a new .handlebars file)

diff --git a/about.html b/about.html
diff --git a/archive.html b/archive.html
diff --git a/banner.html b/banner.html
diff --git a/dist/assets/GitHub.png b/dist/assets/GitHub.png
diff --git a/dist/assets/cloudflare.png b/dist/assets/cloudflare.png
diff --git a/dist/assets/facebook.png b/dist/assets/facebook.png
diff --git a/dist/assets/favicon.ico b/dist/assets/favicon.ico
diff --git a/dist/assets/github-sponsor.png b/dist/assets/github-sponsor.png
diff --git a/dist/assets/jenkins_headshot.png b/dist/assets/jenkins_headshot.png
diff --git a/dist/assets/linaro.png b/dist/assets/linaro.png
diff --git a/dist/assets/linux.png b/dist/assets/linux.png
diff --git a/dist/assets/ljc.jpg b/dist/assets/ljc.jpg
diff --git a/dist/assets/loading_dots.gif b/dist/assets/loading_dots.gif
diff --git a/dist/assets/mac.png b/dist/assets/mac.png
diff --git a/dist/assets/macstadium.png b/dist/assets/macstadium.png
diff --git a/dist/assets/packet.png b/dist/assets/packet.png
diff --git a/dist/assets/ppc64le.png b/dist/assets/ppc64le.png
diff --git a/dist/assets/s390x.png b/dist/assets/s390x.png
diff --git a/dist/assets/scaleway.png b/dist/assets/scaleway.png
diff --git a/dist/assets/slack.png b/dist/assets/slack.png
diff --git a/dist/assets/squares-logo.png b/dist/assets/squares-logo.png
diff --git a/dist/assets/twitter.png b/dist/assets/twitter.png
diff --git a/dist/assets/windows.png b/dist/assets/windows.png