Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rename example pages to be more consistent #488

Closed
joelanman opened this issue Feb 14, 2018 · 6 comments
Closed

Rename example pages to be more consistent #488

joelanman opened this issue Feb 14, 2018 · 6 comments

Comments

@joelanman
Copy link
Contributor

Our example pages have inconsistent naming - this makes it harder than it should be to find the example you're looking for.

For example:

blank-govuk.html
check-your-answers-page.html
confirmation-page.html
override-service-name.html
start-page.html
template-content-page.html
template-data.html
template-question-page-blank.html

Some have -page at the end, some have template- at the start, some have neither

@edwardhorsford
Copy link
Contributor

@joelanman do you have suggestions for what they should be?

@joelanman
Copy link
Contributor Author

I think maybe just as simple as possible, eg:

blank.html
check-your-answers.html
start.html
question.html
content.html

@edwardhorsford
Copy link
Contributor

Makes sense - might be worth moving some of the other templates out of the way then?

There's base templates and then there's the ones users are likely to want. Should they be in a flat folder structure?

@joelanman
Copy link
Contributor Author

its a good point that there are probably two types. Like 'question' is a good blank base for a question page. Whereas override-service-name and template-data aren't base pages, they're example of how to do things. I feel like those should live elsewhere, or maybe not even be pages, just code snippets

@hannalaakso
Copy link
Member

Hi @joelanman

On the basis of the above conversation, would something like the below work? Not sure about the directory name for "example-snippets" though.

views/
├── examples
    ├────  base-templates
         ├── blank-govuk.html
         ├── blank-unbranded.html
    ├────  branching
         ├── index.html
         ├── over-18.html
         ├── under-18.html
    ├────  example-snippets
         ├── content.html
         ├── data.html
         ├── override-service-name.html
         ├── question.html
    ├────  pass-data
         ├── index.html
         ├── vehicle-check-answers.html
         ├── vehicle-features.html
         ├── vehicle-registration.html
         ├── vehicle-type.html
    ├── check-your-answers.html
    ├── confirmation.html
    ├── start.html
    ├── task-list.html

@NickColley
Copy link
Contributor

This is done, thanks Joe

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants