|
| 1 | +--- |
| 2 | +layout: default |
| 3 | +title: Configure |
| 4 | +nav: configure |
| 5 | +--- |
| 6 | + |
| 7 | + |
| 8 | +# Configuration of code-gov-web |
| 9 | +code-gov-web is configurable. You can customize the styling, content and much more. This document is a work in progress and we will continue to add to it. |
| 10 | + |
| 11 | +# Domain |
| 12 | +If you want to host code-gov-web on your own domain, you'll have to change these files: |
| 13 | + - code-gov-web/config/CNAME |
| 14 | + |
| 15 | +# [title](https://github.com/GSA/code-gov-web/blob/master/config/code-gov-config.json#L2) |
| 16 | +To change the title of the website change the `title` property in `code-gov-web/config/code-gov-config.json` |
| 17 | + |
| 18 | +# [twitter handle](https://github.com/GSA/code-gov-web/blob/master/config/code-gov-config.json#L9) |
| 19 | +You can add the handle for your twitter account. This is used to generate the link for the Twitter icon in the top right of each page. Update the handle property in `code-gov-web/config/code-gov-config.json` |
| 20 | + |
| 21 | +# [homepage](https://github.com/GSA/code-gov-web/blob/master/config/code-gov-config.json#L12) |
| 22 | +You can configure everything on the home page. |
| 23 | + |
| 24 | +### [banner](https://github.com/GSA/code-gov-web/blob/master/config/code-gov-config.json#L13) |
| 25 | +You can configure the content inside of the banner area. You change the motto `Sharing America's Code` to whatever you want. You can also change the subtitle, `Unlock the tremendous...`, and description of the help wanted tasks, `Discover how you can...` |
| 26 | + |
| 27 | +# [roadmap](https://github.com/GSA/code-gov-web/blob/master/config/code-gov-config.json#L108) |
| 28 | +The roadmap section is fully configurable. You can see a live example of what the roadmap looks like here: https://code.gov/#/roadmap |
| 29 | + |
| 30 | +### [overview](https://github.com/GSA/code-gov-web/blob/master/config/code-gov-config.json#L109) |
| 31 | +You can configure the text that appears under [overview](https://github.com/GSA/code-gov-web/blob/master/config/code-gov-config.json#L109). This is represented as an array of paragraph HTML text. |
| 32 | +``` |
| 33 | +"overview": [ |
| 34 | + "At Code.gov, we know it’s important to keep an open dialogue with our users. That’s why we’re sharing our plans for the future through this Development Roadmap. Hopefully, it will help you better understand our priorities for the platform.", |
| 35 | + "The Development Roadmap is organized into three categories – Near-term, Mid-term, and Long-term. Priorities are sorted into roadmap categories based on feedback we receive during user interviews. Dependencies and resources are also factors that affect placement on the roadmap. If you want to join the Code.gov user testing group, please email us at <a href='mailto:code@gsa.gov'>Code@gsa.gov</a>." |
| 36 | +], |
| 37 | +``` |
| 38 | +### [near-, mid-, and long-term tasks]((https://github.com/GSA/code-gov-web/blob/master/config/code-gov-config.json#L113) ) |
| 39 | +You can configure your [tasks](https://github.com/GSA/code-gov-web/blob/master/config/code-gov-config.json#L113) for different time durations. They are represented as an array of task objects with each task object including two properties, `name` and `status`. The status can be of three options: `Released`, `In Progress`, or `null`. Here's an example of configuring the mid-term tasks: |
| 40 | +``` |
| 41 | +"mid": [ |
| 42 | + { "name": "Agency pages", "status": null }, |
| 43 | + { "name": "Medium skin", "status": null }, |
| 44 | + { "name": "FAQs page", "status": "In Progress" }, |
| 45 | + { "name": "Admin tool", "status": null }, |
| 46 | + { "name": "Enhanced tools and resources", "status": null }, |
| 47 | + { "name": "Project Details Phase II", "status": null} |
| 48 | +], |
| 49 | +``` |
| 50 | + |
| 51 | +### [disclaimer](https://github.com/GSA/code-gov-web/blob/master/config/code-gov-config.json#L134) |
| 52 | +You can also add a [disclaimer](https://github.com/GSA/code-gov-web/blob/master/config/code-gov-config.json#L134) that says you can't guarantee that features are rolled out according to the roadmap |
| 53 | +``` |
| 54 | +"disclaimer": "This Development Roadmap (Roadmap) is for informational purposes only. The Code.gov team will update the Roadmap as frequently as possible but, given that it’s subject to change at any time, the information presented by the Roadmap should not be used for planning purposes. The information presented in the Roadmap does not represent a solicitation or similar contract vehicle. All items in the Roadmap will be developed and released at the sole discretion of Code.gov, the General Services Agency, the Office of Management and Budget, and the United States Federal Government." |
| 55 | +``` |
| 56 | + |
| 57 | + |
| 58 | +# more soon |
| 59 | +There's many other ways to customize code-gov-web. More documentation coming soon! |
| 60 | + |
| 61 | +# contact |
| 62 | +If you have any questions, you can post an issue on GitHub or email us at code@gsa.gov |
| 63 | + |
| 64 | + |
| 65 | +--- |
| 66 | +Note: cross posted from [https://github.com/GSA/code-gov-web/blob/master/CONFIGURATION.md](https://github.com/GSA/code-gov-web/blob/master/CONFIGURATION.md) |
0 commit comments