USWDS-Tutorial - Bug: Inconsistent reference to theme directory in gulpfile.js
Nobody has claimed this yet.
Assessment
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Newbie friendliness
- 90/100
- Issue type
- Bug
- Clarity
- Clearly specified
- Activity status
- Active
- Tech stack
- javascript
- Domain
- documentation
Research direction
Start by locating the tutorial content for Part Two, Step 7 and Part Seven, Step 3, then compare the gulpfile.js examples. Correct the inconsistent theme directory reference so both steps use the intended value, and verify the surrounding instructions remain consistent.
Written by the indexing model from the issue text.
Description
Describe the bug
In the instructions, in Part Two, Step 7, you instruct us to set the theme path in gulpfile.js:
uswds.paths.dist.theme = './_theme';
Later, in Part Seven, Step 3, the value is displayed while instructing us to set the project Sass source directory in the gulpfile.js but the value has had the initial underscore removed:
uswds.paths.dist.theme = './theme';
uswds.paths.src.projectSass = './assets/css';
Steps to reproduce the bug
- Go to Part Two, Step 7 and note the value of the theme directory being set.
- Go to Part Seven, Step 3, and not the value displayed for the same setting being different than above.
Expected Behavior
- Expect that values between steps that we aren't told to change remain the same for consistency sake and reduce confusion.
Related code
No response
Screenshots
Part Two, Step 7, the setting of the value:
Part Two, Step 8, showing the value again in context of step 8's additions:
Part Seven, Step 3, showing the value again in the context of the change, but its different than before:
System setup
- USWDS Version: 3.14.0
- Device: Laptop
- Operating System: Windows 11 Enterprise
- Browser and version: Chrome Version 153.0.8010.54 (Official Build) (64-bit)
Additional context
I believe -- and sincerely hope -- that this is a simple typo which led to consistency between the steps.
Code of Conduct
- I agree to follow this project's Code of Conduct.
- I checked the current issues for duplicate bug reports.
- Dominant language
- HTML
- Stars
- 45
- Forks
- 36
- Avg merge
- 15m
- Merged PRs (30d)
- 3
Getting set up
This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from uswds/uswds-tutorial
-
Needs: Confirmation Status: Triage Type: Bug
Difficulty 3/5 1-2 days Newbie friendliness 10/100
uswds/uswds-tutorial#65 · 1 comment ·
-
allstar-gsa
Difficulty 2/5 1-3 hours Newbie friendliness 35/100
uswds/uswds-tutorial#62 · 10 comments ·
-
allstar-gsa
Difficulty 2/5 1-3 hours Newbie friendliness 35/100
uswds/uswds-tutorial#60 · 10 comments ·
-
USWDS-Tutorial - Bug: Tutorial extraneous "a" character in titleMay be free again @CTGM-Bixal claimed this 767 days ago, and no pull request is open. Open
uswds/uswds-tutorial#55 · 2 assignees ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 45/100
uswds/uswds-tutorial#35 ·
All issues in uswds/uswds-tutorial
Similar issues
-
Difficulty 1/5 1-3 hours Newbie friendliness 87/100
adri0/scadustats#128 ·
Maintainers usually reply within 1 day
-
Difficulty 1/5 Under an hour Newbie friendliness 84/100
WordPress/hosting-handbook#506 ·
Maintainers usually reply within 2 days
-
Docs: refresh target-app-parity and file-format-parity against mainPossibly taken @vangel76 claimed this today. Open
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
storytold/photocraft#4417 · 1 comment ·
Maintainers usually reply within 1 day
-
documentation help wanted needs-triage
Difficulty 1/5 1-3 hours Newbie friendliness 75/100
hivecommons/hive#11606 · 2 comments ·
Maintainers usually reply within 1 day
-
documentation good first issue launch
Difficulty 2/5 1-3 hours Newbie friendliness 83/100
FlologixAI/etchwork#4 ·