Add documentation and tooling for GOV.UK Components #444
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
dsingleton
force-pushed
the
new-component-docs
branch
from
55315c9 to
df58f95
Compare
|
As implicitly requested, fixed a few typos by pushing a commit. Quite a lot of typos actually. Looks good other than that; I'm happy to merge, but perhaps this wants review from, say, @edds, first. |
|
Need to drop the metadata example as that has now been merged. |
|
Also, I just noticed that the jenkins jobs for testing this PR have hung: "Build has been executing for 2 days 16 hr". I've cancelled them, but that needs investigation. |
dsingleton
force-pushed
the
new-component-docs
branch
from
f52a38f to
7be59c5
Compare
Static is the authorative source for components, including documentation, so should be included here. - As this grows it might want to be split into a README in a components specific directory, tho a good one doesn't exist yet - It might be worth creating a generator to do the creation, just docing for now
Generates all the file scaffolding, in the right places, as the files are a bit spread throughout static at the moment. This will include all the files required to let the component be demo'd on govuk-component Appending to the json docs file is a bit shonky, but we're not planning on using that as a docs method long term. It'll likely be inline with template, or at least one doc file per component, which will make this simpler.
Fixtures are a hash of hashes, the parent hash is fixture_name => fixture The fixture is a hash of locals to be passed to the compontent view.
dsingleton
force-pushed
the
new-component-docs
branch
4 times, most recently
from
dc35623 to
c9a56ef
Compare
|
Cleaned up & rebased. |
edds
added a commit
that referenced
this pull request
Sep 2, 2014
Add documentation and tooling for GOV.UK Components
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This aims to make it easier for developers to understand how components work, how they're structured and how to write their own.
It adds README guidance and a generator to create scaffolding for a new component.
I look forward to the inevitable pointing out of typos, which you are more than welcome to fix in place :]