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

What should the structure of an element page be? #40

Closed
Bjwebb opened this issue Jan 15, 2014 · 4 comments
Closed

What should the structure of an element page be? #40

Bjwebb opened this issue Jan 15, 2014 · 4 comments
Assignees
Labels
Milestone

Comments

@Bjwebb
Copy link
Contributor

Bjwebb commented Jan 15, 2014

Currently this is (each section may not appear if it is empty):

  • Full element path
  • From the schema
  • Attributes
  • Subelements
  • Notes
  • Example usage
  • Changelog
@stevieflow
Copy link
Contributor

Note to talk to @jonihillman and @iatisupport about this

@stevieflow
Copy link
Contributor

Proposed:

  • Full element path
  • From the schema (label: Description)
  • Attributes
  • Notes
  • Example usage
  • Who is using this element - link to dashboard?

Marked as in the "footer" of the content pane:

  • For developers (link to source - although could be a button)
  • Changelog
  • Subelements (putting this at the footer of the page as the list can be long)

@Bjwebb Bjwebb assigned stevieflow and Bjwebb and unassigned bill-anderson and stevieflow Apr 10, 2014
Bjwebb added a commit to IATI/IATI-Standard-SSOT that referenced this issue Apr 14, 2014
@Bjwebb
Copy link
Contributor Author

Bjwebb commented Apr 16, 2014

I've put subelements at the bottom. At the moment all the Extra-Documentation is one contiguous block, and it would require a bit of work to split this up. Therefore the page structure is currently the following:

  • Full element path
  • From the schema
  • Attributes
  • Notes
  • Example usage
  • Changelog
  • For developers
  • Subelements

Where everything from "Notes" to "Changelog" is pulled directly from the Extra-Documentation (so it needs to be in the correct order there)

"Who is using this element - link to dashboard" requires some development work to create - so I've created a separate issue for this IATI/IATI-Standard-SSOT#38 - I don't think this is one we actually need to get done for 1.04, although it would be nice if we did.

Not sure what you're suggestion by "footer of the content pane"

I'm quite happy to rename sections. I think "Definition" might be better than "Description" for the text taken from the schema. Are you also suggesting we change "Developer tools" to "For developers"? I'm happy to do so.

@Bjwebb Bjwebb assigned stevieflow and unassigned Bjwebb Apr 16, 2014
@stevieflow
Copy link
Contributor

Yes, great

"Developer tools" is fine

"footer" - just meant the bottom

@Bjwebb Bjwebb assigned Bjwebb and unassigned stevieflow Apr 16, 2014
Bjwebb added a commit to IATI/IATI-Standard-SSOT that referenced this issue Apr 22, 2014
@Bjwebb Bjwebb closed this as completed Apr 22, 2014
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

3 participants