Skip to content
This repository was archived by the owner on Jan 30, 2024. It is now read-only.

Commit a612191

Browse files
mvogelgesangmvogelgesang
authored
Merge pull request #26 from GSA/release-1.2.0
Release 1.2.0
2 parents 1adf070 + ffd2107 commit a612191

File tree

54 files changed

+4134
-2276
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

54 files changed

+4134
-2276
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 18 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,47 @@
11
---
22
name: Bug report
33
about: Create a report to help us improve
4-
54
---
65

7-
<!-- Issues should follow our Issue Guidelines, which are at https://github.com/GSA/code-gov-front-end/blob/master/CONTRIBUTING.md#issue-guidelines -->
6+
<!-- Issues should follow our Issue Guidelines, which are at https://github.com/GSA/uswds-sf-lightning-community/blob/master/CONTRIBUTING.md#issue-guidelines -->
87

98
**Describe the bug**
9+
1010
<!-- A clear and concise description of what the bug is. -->
1111

1212
**To Reproduce**
13+
1314
<!-- Steps to reproduce the behavior:
1415
1. Go to '...'
1516
2. Click on '....'
1617
3. Scroll down to '....'
1718
4. See error
1819
-->
19-
1.
20-
2.
20+
21+
1.
22+
2.
2123

2224
**Expected behavior**
25+
2326
<!-- A clear and concise description of what you expected to happen. -->
2427

2528
**Screenshots**
29+
2630
<!-- If applicable, add screenshots to help explain your problem. -->
2731

2832
**Desktop (please complete the following information):**
29-
- OS: [e.g. iOS]
30-
- Browser [e.g. chrome, safari]
31-
- Version [e.g. 22]
33+
34+
- OS: [e.g. iOS]
35+
- Browser [e.g. chrome, safari]
36+
- Version [e.g. 22]
3237

3338
**Smartphone (please complete the following information):**
34-
- Device: [e.g. iPhone6]
35-
- OS: [e.g. iOS8.1]
36-
- Browser [e.g. stock browser, safari]
37-
- Version [e.g. 22]
39+
40+
- Device: [e.g. iPhone6]
41+
- OS: [e.g. iOS8.1]
42+
- Browser [e.g. stock browser, safari]
43+
- Version [e.g. 22]
3844

3945
**Additional context**
46+
4047
<!-- Add any other context about the problem here. -->

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,22 @@
11
---
22
name: Feature request
33
about: Suggest an idea for this project
4-
54
---
65

7-
<!-- Issues should follow our Issue Guidelines, which are at https://github.com/GSA/code-gov-front-end/blob/master/CONTRIBUTING.md#issue-guidelines -->
6+
<!-- Issues should follow our Issue Guidelines, which are at https://github.com/GSA/uswds-sf-lightning-community/blob/master/CONTRIBUTING.md#issue-guidelines -->
87

98
**Is your feature request related to a problem? Please describe.**
9+
1010
<!-- A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] -->
1111

1212
**Describe the solution you'd like**
13+
1314
<!-- A clear and concise description of what you want to happen. -->
1415

1516
**Describe alternatives you've considered**
17+
1618
<!-- A clear and concise description of any alternative solutions or features you've considered. -->
1719

1820
**Additional context**
21+
1922
<!-- Add any other context or screenshots about the feature request here. -->

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -11,30 +11,31 @@ For more information, see the `CONTRIBUTING` guide. -->
1111

1212
This PR fixes/implements the following **bugs/features**
1313

14-
* [ ] Bug 1
15-
* [ ] Bug 2
16-
* [ ] Feature 1
17-
* [ ] Feature 2
18-
* [ ] Breaking changes
14+
- [ ] Bug 1
15+
- [ ] Bug 2
16+
- [ ] Feature 1
17+
- [ ] Feature 2
18+
- [ ] Breaking changes
19+
1920

20-
<!-- You can skip this if you're fixing a typo or adding an app to the Showcase. -->
2121

2222
Explain the **motivation** for making this change. What existing problem does the pull request solve?
2323

2424
<!-- Example: When "Adding a function to do X", explain why it is necessary to have a way to do X. -->
2525

2626
**Test plan (required)**
2727

28+
2829
Demonstrate the code is solid.
2930
<!-- Example: The exact commands you ran and their output, screenshots / videos if the pull request changes UI. -->
3031

31-
<!-- Make sure tests pass on Circle CI. -->
32-
3332
**Code formatting**
3433

35-
<!-- See the simple style guide. -->
34+
<!-- We use Prettier and so should you. -->
35+
3636

3737
**Closing issues**
3838

3939
<!-- Put `closes #XXXX` in your comment to auto-close the issue that your PR fixes (if such). -->
40+
4041
Fixes #

‎.prettierrc‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
{
2+
"trailingComma": "none",
3+
"overrides": [
4+
{
5+
"files": "**/lwc/**/*.html",
6+
"options": { "parser": "lwc" }
7+
},
8+
{
9+
"files": "*.{cmp,page,component,design,auradoc}",
10+
"options": { "parser": "html" }
11+
}
12+
]
13+
}

‎CONTRIBUTING.md‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
# Welcome!
1+
# Welcome
22

33
We're so glad you're thinking about contributing to a U.S. Government open source project! If you're unsure about anything, just ask -- or submit the issue or pull request anyway. The worst that can happen is you'll be politely asked to change something. We love all friendly contributions.
44

55
## How to contribute to this project
66

77
- We want to ensure a welcoming environment for all of our projects. Our staff follows this [Code of Conduct](CODE_OF_CONDUCT.md) and all contributors should do the same.
88
- Report bugs and request features via Github Issues
9-
- If you are not sure that the issue is related to the website you can [create the issue in our general repository](https://github.com/gsa/code-gov/issues/new): [code-gov](https://github.com/gsa/code-gov)
9+
- If you are not sure that the issue is related to the website you can [create the issue in our general repository](https://github.com/gsa/code-gov/issues/new): [code-gov](https://github.com/gsa/code-gov)
1010
- [Email us](mailto://code@gsa.gov) your ideas on how to improve the code-gov-front-end. We're always open to suggestions.
1111
- Create a [Github pull request](https://help.github.com/articles/creating-a-pull-request/) with new functionality or fixing a bug.
1212
- Improve or create documentation.
@@ -19,12 +19,12 @@ As noted in [LICENSE](LICENSE.md), this project is in the worldwide public domai
1919

2020
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.
2121

22-
# Issue Guidelines
23-
In the interest of making it easier for our contributors to manage site issues, we request that issues follow certain guidelines. Our developers mainly use [issues](/issues) to identify and prioritize their work. If you have questions about code.gov or would like start a general discussion, we kindly request that you email us at code@gsa.gov. Our issue guidelines are a living document and a work in progress, so feel free to offer feedback on it, by emailing us at code@gsa.gov
24-
- **Specific**: The issue makes specific requests. An example of a specific request would be `Reduce the Size of Images`. An example of a non-specific request would be `Improve Site Performance`.
25-
- **Measurable**: The issue has specific requirements and can be closed when those requirements are met. This helps us track the progress in addressing problems. For example, tech debt is always something to work on, so we should create separate issues for this, such as `Consolidate Styling of Repo and Task Cards` and `Convert Validator from Monaco Editor to jsoneditor`, rather than `Address Tech Debt`.
26-
- **Actionable**: An issue should request a specific action from a member of the code.gov team or community. An example of something actionable would be `Remove Debugging Text from Loading Screen`. An example of something that isn't actionable by our team or community is `My city should be forking Code.gov`.
27-
- **Realistic**: The issue is something that is achievable by the resources of the project, including contributions from the open source community. An example of a realistic issue is `Include Line Numbers in Validator`.
28-
- **Time-Aware**: The issue is something that can be resolved within 6 months. If you think your issue might take longer, we encourage you to break up your issues into smaller issues (like stepping stones) that we can address. We can still work on big problems, but it is easier for us to track progress and identify what we need to work on, when big problems are broken up into smaller ones.
29-
30-
22+
## Issue Guidelines
23+
24+
In the interest of making it easier for our contributors to manage site issues, we request that issues follow certain guidelines. Our developers mainly use [issues](/issues) to identify and prioritize their work. If you have questions about code.gov or would like start a general discussion, we kindly request that you email us at code@gsa.gov. Our issue guidelines are a living document and a work in progress, so feel free to offer feedback on it, by emailing us at [gsalabs@gsa.gov](mailto://gsalabs@gsa.gov)
25+
26+
- **Specific**: The issue makes specific requests. An example of a specific request would be `Reduce the Size of Images`. An example of a non-specific request would be `Improve Site Performance`.
27+
- **Measurable**: The issue has specific requirements and can be closed when those requirements are met. This helps us track the progress in addressing problems. For example, tech debt is always something to work on, so we should create separate issues for this, such as `Consolidate Styling of Repo and Task Cards` and `Convert Validator from Monaco Editor to jsoneditor`, rather than `Address Tech Debt`.
28+
- **Actionable**: An issue should request a specific action from a member of the code.gov team or community. An example of something actionable would be `Remove Debugging Text from Loading Screen`. An example of something that isn't actionable by our team or community is `My city should be forking Code.gov`.
29+
- **Realistic**: The issue is something that is achievable by the resources of the project, including contributions from the open source community. An example of a realistic issue is `Include Line Numbers in Validator`.
30+
- **Time-Aware**: The issue is something that can be resolved within 6 months. If you think your issue might take longer, we encourage you to break up your issues into smaller issues (like stepping stones) that we can address. We can still work on big problems, but it is easier for us to track progress and identify what we need to work on, when big problems are broken up into smaller ones.

‎INSTALLATION.md‎

Lines changed: 62 additions & 62 deletions
Original file line numberDiff line numberDiff line change
@@ -2,31 +2,31 @@
22

33
## Dependencies
44

5-
* Font Awesome
6-
* **Required For** fontAwesomeIcon and socialMediaNavMenu components.
7-
* Register with Font Awesome to create icon kits, [https://fontawesome.com/start](https://fontawesome.com/start). You'll receive a JS snippet to include in your site. Hold onto that for later.
5+
- Font Awesome
6+
- **Required For** fontAwesomeIcon and socialMediaNavMenu components.
7+
- Register with Font Awesome to create icon kits, [https://fontawesome.com/start](https://fontawesome.com/start). You'll receive a JS snippet to include in your site. Hold onto that for later.
88

99
## Instructions
1010

11-
* Two methods available to push code to your sandbox
12-
* Install via [https://test.salesforce.com/packaging/installPackage.apexp?p0=04t350000001lQx](https://test.salesforce.com/packaging/installPackage.apexp?p0=04t350000001lQx)
13-
* Clone this repository and push
14-
* Enable Communities in your Salesforce org
15-
* For new communities
16-
* Create new community (Setup > Communities > New Template (for e.g. Customer Account Portal)
17-
* Provide Name > Builder > Theme
18-
* Select USWDS Lightning Community
19-
* For existing communities
20-
* (Setup > Communities> Builder > Theme)
21-
* Select USWDS Lightning Community
22-
* Enter name of community and a community specific url (if desired)
23-
* From Workspaces, navigate to Administration
24-
* Login & Registration
25-
* Update Logo to use Agency-specific logo
26-
* Update Footer text. Note, US Government agencies do not hold copyright, see [Government Works](https://www.usa.gov/government-works). Entering © My Agency is improper. Instead, just enter the agency name.
27-
* Set Logout Page URL
28-
* Save
29-
* Update other settings as needed.
11+
- Two methods available to push code to your sandbox
12+
- Install via [https://test.salesforce.com/packaging/installPackage.apexp?p0=04t350000001lQx](https://test.salesforce.com/packaging/installPackage.apexp?p0=04t350000001lQx)
13+
- Clone this repository and push
14+
- Enable Communities in your Salesforce org
15+
- For new communities
16+
- Create new community (Setup > Communities > New Template (for e.g. Customer Account Portal)
17+
- Provide Name > Builder > Theme
18+
- Select USWDS Lightning Community
19+
- For existing communities
20+
- (Setup > Communities> Builder > Theme)
21+
- Select USWDS Lightning Community
22+
- Enter name of community and a community specific url (if desired)
23+
- From Workspaces, navigate to Administration
24+
- Login & Registration
25+
- Update Logo to use Agency-specific logo
26+
- Update Footer text. Note, US Government agencies do not hold copyright, see [Government Works](https://www.usa.gov/government-works). Entering © My Agency is improper. Instead, just enter the agency name.
27+
- Set Logout Page URL
28+
- Save
29+
- Update other settings as needed.
3030

3131
### Experience Builder Setup
3232

@@ -36,62 +36,62 @@ Navigate to Experience Builder by clicking Administration in the top left, and c
3636

3737
This theme relies on five navigation menus:
3838

39-
* Main Navigation
40-
* Header Secondary Navigation - below Search
41-
* Limit this nav to three or fewer entries
42-
* Main Footer Nav
43-
* Footer Secondary Nav
44-
* Many agencies require standard links on every website such as Privacy Policy, Accessibility, SORN, etc.
45-
* Social Media Nav
39+
- Main Navigation
40+
- Header Secondary Navigation - below Search
41+
- Limit this nav to three or fewer entries
42+
- Main Footer Nav
43+
- Footer Secondary Nav
44+
- Many agencies require standard links on every website such as Privacy Policy, Accessibility, SORN, etc.
45+
- Social Media Nav
4646

4747
#### Change Theme Layout and Settings
4848

49-
* Settings > Theme > Configure
50-
* Change Theme Layout Component for the Default and Login Theme Layouts to USWDS Theme Layout. Accept alert and click OK.
51-
* Add Theme Images
52-
* Navigate to Theme (paint brush)
53-
* Update Images
54-
* Upload your organization logo under Company Logo. Update Login Page Background Image if desired.
55-
* A logo with transparent background is best as the header and footer are different colors.
56-
* Update Theme Settings
57-
* Work down the list of theme settings. As you tab through, the underlying page will update after each field.
58-
* If you created a community specific URL ...force.com/blah, update the Path to Home Page section to include beginning of URI path
59-
* Enter navigation menu names for each Nav Menu Name section
60-
* If you plan to override a particular section, toggle the section on to reveal an Aura.Component[] drop zone
61-
* Update Theme Colors
62-
* This repository ships with base theme colors but can be customized to specific needs. While not comprehensive, the following maps color settings to components in the community.
63-
* Action Color
64-
* Tab Component (specifically active tab)
65-
* Tile Menu
66-
* Overlay Text Color
67-
* User Profile Menu
68-
* Detail Text Color
69-
* Tabs (inactive)
49+
- Settings > Theme > Configure
50+
- Change Theme Layout Component for the Default and Login Theme Layouts to USWDS Theme Layout. Accept alert and click OK.
51+
- Add Theme Images
52+
- Navigate to Theme (paint brush)
53+
- Update Images
54+
- Upload your organization logo under Company Logo. Update Login Page Background Image if desired.
55+
- A logo with transparent background is best as the header and footer are different colors.
56+
- Update Theme Settings
57+
- Work down the list of theme settings. As you tab through, the underlying page will update after each field.
58+
- If you created a community specific URL ...force.com/blah, update the Path to Home Page section to include beginning of URI path
59+
- Enter navigation menu names for each Nav Menu Name section
60+
- If you plan to override a particular section, toggle the section on to reveal an Aura.Component[] drop zone
61+
- Update Theme Colors
62+
- This repository ships with base theme colors but can be customized to specific needs. While not comprehensive, the following maps color settings to components in the community.
63+
- Action Color
64+
- Tab Component (specifically active tab)
65+
- Tile Menu
66+
- Overlay Text Color
67+
- User Profile Menu
68+
- Detail Text Color
69+
- Tabs (inactive)
7070

7171
#### Add Font Awesome JS
7272

73-
Fontawsome needs to be a trusted site for both scripts and other resources. There are two sites that need to be defined by Salesforce:
73+
Fontawsome needs to be a trusted site for both scripts and other resources. There are two sites that need to be defined by Salesforce:
7474

7575
1. Under Salesforce Setup (Not in Experience Builder) search for CSP Trusted Sites.
7676
1. Click New Trusted Site.
77-
1. Trusted Site Name: kitfreefontawsome
78-
1. Trusted Site URL: [https://kit-free.fontawesome.com](https://kit-free.fontawesome.com)
79-
1. Context: Communities
80-
1. Leave all other boxes checked
77+
1. Trusted Site Name: kitfreefontawsome
78+
1. Trusted Site URL: [https://kit-free.fontawesome.com](https://kit-free.fontawesome.com)
79+
1. Context: Communities
80+
1. Leave all other boxes checked
8181
1. Click Save
8282

83-
Back in Experience Builder > Settings > Security.
83+
Back in Experience Builder > Settings > Security.
8484

8585
1. Change the Content Secuirty Policy (CSP) to "Allow Inline Scripts and Script Access to Whitelisted Third-party Hosts
8686
1. Click + Add Trusted Site.
87-
1. Name: fontawesome
88-
1. URL: [https://kit.fontawesome.com](https://kit.fontawesome.com)
87+
1. Name: fontawesome
88+
1. URL: [https://kit.fontawesome.com](https://kit.fontawesome.com)
8989

9090
Enter the header script Tag:
91-
From Settings>Advanced.
91+
From Settings>Advanced.
9292

93-
1. Click Edit Head Markup.
94-
1. Paste the script tag.
93+
1. Click Edit Head Markup.
94+
1. Paste the script tag.
9595
1. Click Save
9696

97-
When saved you should not get any CSP errors.
97+
When saved you should not get any CSP errors.

‎README.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# US Web Design System Salesforce Lightning Community Theme
22

3+
[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)
4+
35
An implementation of the US Web Design System for Salesforce Lightning Communities.
46

57
![US Web Design System Salesforce Community Template Example](img/desktop.png "US Web Design System Salesforce Community Theme Example")

0 commit comments

Comments
 (0)