juliawu / datacommons-docsite

Fork of Data Commons documentation website for development

Data Commons documentation site

This repo hosts Data Commons API documentation available at https://docs.datacommons.org/. The site is hosted in Github Pages, and generated by Jekyll.

About Data Commons

Data Commons is an open knowledge graph that provides a unified view across multiple public data sets and statistics. We've bootstrapped the graph with lots of data from US Census, CDC, NOAA, etc., and through collaborations with the New York Botanical Garden, Opportunity Insights, and more. However, Data Commons is meant to be for community, by the community. We're excited to work with you to make public data accessible to everyone.

To see the extent of data we have today, browse the Knowledge Graph.

Markdown

The Data Commons documentation uses Kramdown Markdown.

Navigation

The navigation bar is generated automatically from the YAML "front matter" at the top of each Markdown file. See Using YAML front matter for details.

Build locally

The documentation site is built using Jekyll. To run this locally:

1. One-time setup step: Install Ruby.
2. Run bundle update
3. Run bundle exec jekyll serve --incremental

You can continue to make local changes and just refresh the browser. You will need to rerun bundle exec jekyll serve if you make changes that affect the overall site, such as changes to YAML files, cross-page links, etc.

Tip: If you want to make the staged site accessible to others (and not just on the loopback), add --host 0.0.0.0 to the command. Then, users can access the site using the hostname of the machine where the site is running.

License

Apache 2.0

Contribute changes

One-time setup steps

1. In https://github.com/datacommonsorg/docsite, click the Fork button to fork the repo.

2. Clone your forked repo to your desktop:

    git clone https://github.com/USER_NAME/docsite
    

   This adds your fork as the remote called origin.

3. Add datacommonsorg/docsite repo as a remote:

    git remote add REMOTE_NAME https://github.com/datacommonsorg/docsite.git
    

Create a pull request

Every time you want to create a pull request, create a new branch and sync to the master branch:

git checkout master
git pull REMOTE_NAME master
git checkout -b BRANCH_NAME

Make your changes, and then create the PR as follows:

git add .
git commit -m "COMMIT_MESSAGE"
git push -u origin BRANCH_NAME

Then, in github.com, in your forked repo, you can send a pull request. You will need to assign at least one reviewer to approve.

If this is your first time contributing to a Google Open Source project, you may need to follow the steps in CONTRIBUTING.md. Be sure to follow the style guide when submitting documentation PRs.

Wait for approval of the pull request and merge the change.

Support

For general questions or issues, please open an issue on our issues page. For all other questions, please send us feedback.

Note - This is not an officially supported Google product.