Skip to content
This repository has been archived by the owner on Dec 8, 2017. It is now read-only.

Update README to exclude ./go update #324

Open
wants to merge 3 commits into
base: staging
Choose a base branch
from
Open

Update README to exclude ./go update #324

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1620eea
Update README to exclude ./go update
Dec 23, 2015
ab067e5
Improve sphinx formatting in README
Dec 23, 2015
ebf9f3d
Add instructions on how to load data
Dec 23, 2015
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
16 changes: 8 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,11 @@ Is there data that you'd like to see about our projects that's not listed in [th

1. Clone the dashboard repo.
1. Install all its dependencies by running `./go init` in your terminal.
1. Run `./go update` and `./go serve` to serve the site locally in your browser.
1. Run `./go serve` to serve the site locally in your browser.
1. Copy the `_data/projects.json.example` file to `_data/projects.json`
1. Run `_data/import-public.rb` script to load the fake projects.
1. visit http://localhost:4000/dashboard/ in your web browser to see the local site.

By default you get all of our projects. You can refresh their information by running the `_data/import-public.rb` script.


## Editing the 18F Dashboard

Expand All @@ -38,13 +38,13 @@ Putting your information on the dashboard is a three step process. First, you'll

B. If your project does not have a github repository, you may add a file to [data-private/projects](https://github.com/18F/data-private/tree/master/projects) that conforms to the same format as `about.yml`.

2. Coming Soon: *Preview your dashboard page.* You will be able to see what your page will look like before starting the review process. The dashboard preview feature allows the display of a page based on external data hosted on GitHub.
2. Coming Soon: *Preview your dashboard page.* You will be able to see what your page will look like before starting the review process. The dashboard preview feature allows the display of a page based on external data hosted on GitHub.

## Previewing your submission

_Right now, the easiest way to preview is to first submit a pull request to your own project or data-private with new about.yml content for your own team members to review. You can also drop your project's about.yml details into the #writing-lab Slack channel or ask those folks to review your PR as well.
Right now, the easiest way to preview is to first submit a pull request to your own project or data-private with new `about.yml` content for your own team members to review. You can also drop your project's `about.yml` details into the #writing-lab Slack channel or ask those folks to review your PR as well.

We provide a preview link for you to use with your about.yml file. Copy the link to the about.yml file in GitHub and drop it in this link. Make sure you delete the extra apostrophe at the end. If you have any questions about this, please drop by the #Dashboard channel in Slack. `https://18f.gsa.gov/dashboard/project/preview?url=YOUR_ABOUT_YML`.
We provide a preview link for you to use with your `about.yml` file. Copy the link to the `about.yml` file in GitHub and drop it in this link. Make sure you delete the extra apostrophe at the end. If you have any questions about this, please drop by the #Dashboard channel in Slack. `https://18f.gsa.gov/dashboard/project/preview?url=YOUR_ABOUT_YML`.

### Example preview

Expand All @@ -54,9 +54,9 @@ The [Open Opps about.yml](https://github.com/18F/openopps-platform/blob/dev/.abo

3. When the content looks good to you and your team, it is time to propose to 18F Comms that your project be showcased on the dashboard. You can do this by:

A. Editing the [project_filter.yml](https://github.com/18F/dashboard/blob/staging/_data/project_filter.yml) to add your project to the list. Then submit as a pull request to have your changes integrated.
A. Editing the [project_filter.yml](https://github.com/18F/dashboard/blob/staging/_data/project_filter.yml) to add your project to the list. Then submit as a pull request to have your changes integrated.

B. Filing an [issue](https://github.com/18F/dashboard/issues/new) with a link to your about.yml github URL, and we'll queue it up for the next sprint.
B. Filing an [issue](https://github.com/18F/dashboard/issues/new) with a link to your `about.yml` github URL, and we'll queue it up for the next sprint.

New content is reviewed at least once a week and the website is updated subsequently. Keep an eye on your pull-requests, editorial folk will make comments there with suggested improvements.

Expand Down