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

Updated Layout Builder developer documentation #17

Merged
merged 14 commits into from
Jan 9, 2023

Conversation

shelleygoetz
Copy link

@shelleygoetz shelleygoetz commented Dec 20, 2022

Added documentation for Layout Builder v2 components; updated field naming conventions for v1 components.

@shelleygoetz shelleygoetz changed the title Added partners to documentation Updated Layout Builder developer documentation Jan 3, 2023
@shelleygoetz shelleygoetz marked this pull request as ready for review January 5, 2023 23:07
Copy link
Collaborator

@froboy froboy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@shelleygoetz this is super duper, just a lot of nits and some general questions.

One overall thing I didn't mention... from what I've seen the convention in Drupal Core is for field names to use sentence case, like Section heading. We alternate a little here, so that might be a thing to clean up as well.

|----------------|----------------------------------|----------------------------|----------|-------------|-----------|------------------------|-------|
| Section heading | (inherit) | | | | | | H2
| Section subheading | (inherit) | | | | | | H3
| Amenity name | Text (plain) | Entity reference (amenities taxonomy?) | yes | unlimited | | | Taxonomy? |
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@shelleygoetz it's unclear to me what the "Amenity name" field is for in this component. If it's pulling Amenities from the Branch type then there shouldn't need to be any options at all, right?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Amenity name is just the term for the amenity (i.e. "Pool", "Gymnasium", et al). From what I recall, these amenities were set up to pull from a taxonomy because there is a lot of re-use across branches, so admins should be able to add an existing term to the component, or add a new term to the taxonomy. I'm still waiting on the design from Jessye, so we can discuss further after we have designs in hand.

content/en/docs/content-structure/layout-builder/_index.md Outdated Show resolved Hide resolved
content/en/docs/content-structure/layout-builder/_index.md Outdated Show resolved Hide resolved
content/en/docs/content-structure/layout-builder/_index.md Outdated Show resolved Hide resolved
content/en/docs/content-structure/layout-builder/_index.md Outdated Show resolved Hide resolved
| Section heading | (inherit) | | | | | | H2 |
| Section subheading | (inherit) | | | | | | H3 |

## Related Events
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If everything about them otherwise is the same, I think Related Articles and Related Events could be covered under one block, either a more generalized Views Reference block or something like that.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK, sounds good! Whatever you think will make the most sense to developers :)

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree @froboy
Unless there will be some not compatible differences in the future we don't know yet

content/en/docs/content-structure/layout-builder/_index.md Outdated Show resolved Hide resolved
content/en/docs/content-structure/layout-builder/_index.md Outdated Show resolved Hide resolved
content/en/docs/content-structure/layout-builder/_index.md Outdated Show resolved Hide resolved
Copy link
Collaborator

@froboy froboy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Superduper! All those changes look great, just couple more really minor ones and then we're good to go!

@shelleygoetz
Copy link
Author

Layout Builder v2 components added; updates to field naming conventions for v1 components.

@podarok podarok merged commit 979f290 into YCloudYUSA:main Jan 9, 2023
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

Successfully merging this pull request may close these issues.

3 participants