@code.gov/site-map-generator v1.0.14

code-gov-site-map-generator

Generates Sitemap.xml for Code.gov

Introduction

Code.gov is a website promoting good practices in code development, collaboration, and reuse across the U.S. Government. Code.gov provides tools and guidance to help agencies implement the Federal Source Code Policy. It also includes an inventory of government custom code to promote reuse between agencies and provides tools to help government and the public collaborate on open source projects.

To learn more about the project, check out this blog post.

Code.gov is an open source project, so we invite your contributions, be it in the form of code, design, or ideas.

Setup instructions

To run this app locally you'll need a Code.gov API key. If you don't have one, go to the https://developers.code.gov/key.html to obtain one.

Once you have an API key, clone the repo and run the npm install command in the project's root directory to install all of the project’s dependencies.

Run cp env.example .env to create a template .env file in the root directory of the project

Replace “your api key goes here” in the .env file with your API key

Generating a new sitemap.xml

Create a new branch for the sitemap update. On this branch, run the npm run generate terminal command to run the sitemap generation script. Once generated, verify that the repository count matches the project on the Browse Projects page on production. Commit and push the new sitemap your new branch. Submit a PR to merge this branch into master. After the PR is merged, run git checkout master and git pull origin master to update your local repository.

Publish the new sitemap to npm following the instructions in the Component Release Management. This step is required to ensure that code-gov-front-end consumes the latest version of this component.

Questions?

Twitter: @CodeDotGov Email: code@gsa.gov LinkedIn: code-gov Join our #opensource-public Slack channel: https://chat.18f.gov/

Contributing

See CONTRIBUTING for additional information.

Public domain

This project is in the worldwide public domain. As stated in CONTRIBUTING:

This project is in the public domain within the United States, and copyright and related rights in the work worldwide are waived through the CC0 1.0 Universal public domain dedication.

All contributions to this project will be released under the CC0 dedication. By submitting a pull request, you are agreeing to comply with this waiver of copyright interest.