update documentation and examples (#40)

update documentation and examples

Author: eddietejeda

README.md

@@ -37,30 +37,40 @@ This repository contains the following examples and functionality:
 
 ```
 ---
-title: Example Page
+title: Collections Page
 layout: data
-permalink: /jobs
-datafile: jobs
+permalink: /collections
+datafile: collections
 ---
 ```
 
-The reference to `datafile` referers to the name of the file in `_data/jobs.yml` and loops through the values. Feel free to modify this as needed.
+The reference to `datafile` referers to the name of the file in `_data/collections.yml` and loops through the values. Feel free to modify this as needed.
 
 ✅  There are two different kinds of `pages`, one does not have a side bar navigation, and the other uses `_includes/sidenav.html`. You can enable this option by adding `sidenav: true` to your page front matter.
 
 ```
 ---
-title: Example Page with Sidebar
+title: Document with Sidenav
 layout: page
 sidenav: true
-permalink: /example-page-with-sidebar
+permalink: /document-with-sidenav
 ---
 ```
 
-
 ✅ Enable search with [Search.gov](https://search.gov) by adding option to `_config.yml`. 
 
 
+```
+---
+searchgov:
+  endpoint: https://search.usa.gov  # You should not change this.
+  affiliate: federalist-uswds-example # replace this with your search.gov account 
+  access_key: your-access-key # This is placeholder. Not private.
+  inline: true #this renders the results on the same domain. Otherwise, it will render the results in the search.gov domain
+---
+```
+
+
 ## How to edit
 - We try to keep configuration options to a minimum so you can easily remove functionality, but you can review `_config.yml` to see the options that are available to you. There are a few values on top that you **need** to change. They make reference to the agency name and contact information. The advanced options at the bottom should be changed only if you know what you know what you're doing.
 - Do not edit files in the `assets/` folder. This folder is reserved for serving assets once the sites is compiled. If you want add your own custom code, add and edit files in `src/`, ideally mirroring the `assets/` folder structure. This will keep the code repository small and not include unneccessary files. 
@@ -69,6 +79,7 @@ permalink: /example-page-with-sidebar
 - You will most certainly need to edit files in `_includes/`, which include the primary menu, side navigation, logos etc
 - `index.html` may not require much editing, depending on how you customize `hero.html` and `highlights.html`.
 - `_layouts/` may require the least amount of editing of all the files since they are primarily responsible for printing the content.
+- `blog/search.html` is by search.gov. If you need to stylize results page, this is where you will do it.
 - `blog/index.html` can be edited, but be careful. It will impact the pagination system for the posts. If you do edit the file, be prepared to edit `_config.yml`. You should also familiarize yourself with [jekyll-paginate-v2](https://github.com/sverrirs/jekyll-paginate-v2)
 - Non-developers should focus only on `_posts` and `_pages`
 
@@ -108,7 +119,6 @@ Note that when built by Federalist, `npm run federalist` is used instead of the
 - [Jekyll](https://jekyllrb.com/docs/) - The primary site engine that builds your code and content.
 - [Front Matter](https://jekyllrb.com/docs/frontmatter) - The top of each page/post includes keywords within `--` tags. This is meta data that helps Jekyll build the site, but you can also use it to pass custom variables.
 - [U.S. Web Design System v 2.0](https://v2.designsystem.digital.gov) 
-- [Jekyll Search](https://github.com/18F/jekyll_pages_api_search/)
 
 
 ## Contributing

_data/jobs.yaml _data/collections.yaml_data/jobs.yaml renamed to _data/collections.yaml

@@ -1,28 +1,19 @@
 # We can add any kind of data in this _data folder and this file.
-# In this example, we create a simple array of options and then in the _pages/jobs.md file we 
+# In this example, we create a simple array of options and then in the _pages/collections.md file we 
 # Reference this data file in 'datafile' in the Front Matter and _layouts/list.html renders it 
 # This is simple, hopefully provides you with a good enough example to make changes as needed
-- name: Site Lead
-  url: https://join.tts.gsa.gov/
+- name: GSA
+  url: https://gsa.gov
   description: Lorem ipsum dolor sit amet, consectetur adipiscing elit. Donec dapibus interdum pellentesque. Integer eu vehicula elit. Sed cursus magna in dui suscipit rhoncus. 
 
-- name: Cloud Adoption Specialist
-  url: https://join.tts.gsa.gov/
+- name: USDA
+  url: http://usda.gov/
   description: Lorem ipsum dolor sit amet, consectetur adipiscing elit. Donec dapibus interdum pellentesque. Integer eu vehicula elit. Sed cursus magna in dui suscipit rhoncus. 
 
-- name: Contact Center Specialist
-  url: https://join.tts.gsa.gov/
+- name: Performance.gov
+  url: http://performance.gov/
   description: Lorem ipsum dolor sit amet, consectetur adipiscing elit. Donec dapibus interdum pellentesque. Integer eu vehicula elit. Sed cursus magna in dui suscipit rhoncus. 
 
-- name: Customer Experience Specialist
-  url: https://join.tts.gsa.gov/
+- name: Login.gov
+  url: https://login.gov
   description: Lorem ipsum dolor sit amet, consectetur adipiscing elit. Donec dapibus interdum pellentesque. Integer eu vehicula elit. Sed cursus magna in dui suscipit rhoncus. 
-
-- name: Data Analytics Specialist
-  url: https://join.tts.gsa.gov/
-  description: Lorem ipsum dolor sit amet, consectetur adipiscing elit. Donec dapibus interdum pellentesque. Integer eu vehicula elit. Sed cursus magna in dui suscipit rhoncus. 
-
-- name: IT Infrastructure Optimization Specialist
-  url: https://join.tts.gsa.gov/
-  description: Lorem ipsum dolor sit amet, consectetur adipiscing elit. Donec dapibus interdum pellentesque. Integer eu vehicula elit. Sed cursus magna in dui suscipit rhoncus. 
-  

_pages/jobs.md _pages/collections.md_pages/jobs.md renamed to _pages/collections.md

@@ -1,8 +1,8 @@
 ---
-title: Jobs
+title: Collections
 layout: data
-permalink: /jobs
-datafile: jobs
+permalink: /collections
+datafile: collections
 ---
 
 This is an example for list data file contents