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.

Sign up for GitHub

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

Jump to bottom

Rename and document customization options #206

Merged
merged 4 commits into from
Apr 20, 2023
Merged

Rename and document customization options #206

merged 4 commits into from
Apr 20, 2023

Conversation

jp7677
Copy link
Collaborator

@jp7677 jp7677 commented Apr 19, 2023 •
edited
Loading

Just readme additions.

This was referenced Apr 19, 2023
Closed
Closed
@jp7677
Copy link
Collaborator Author

jp7677 commented Apr 19, 2023 •
edited
Loading

We could rename the properties like mentioned in #121 (comment) (and following) as part of this.

@jp7677 jp7677 changed the title Document customization options Rename and document customization options Apr 19, 2023
@jp7677
Copy link
Collaborator Author

jp7677 commented Apr 19, 2023 •
edited
Loading

We could rename the properties like mentioned in #121 (comment) (and following) as part of this.

It's already done as part of this PR.

Since this is a breaking change, we need to add this explicitly to the release notes.
Note that I'm fine to make a clean cut and don't support the old names right away. Not really nice, but it's just about styling and easily adjusted.

@jp7677 jp7677 requested a review from dirkgroot April 19, 2023 14:57
@dirkgroot
Copy link
Collaborator

Since this is a breaking change, we need to add this explicitly to the release notes. Note that I'm fine to make a clean cut and don't support the old names right away. Not really nice, but it's just about styling and easily adjusted.

Agreed. It's a breaking change, but I think backwards compatibility is not needed, when we do a minor version bump + explicit clear notification in the release notes.

@qtzar
Copy link
Contributor

qtzar commented Apr 19, 2023

I would agree, details in the release notes on the change should be sufficient.

jp7677
jp7677 commented Apr 20, 2023
View reviewed changes
docs/example/workspace.dsl Outdated Show resolved Hide resolved
@jp7677
Rename generatr view properties
40ba551 
Prefixing our properties with 'generatr' should avoid
a lot of confusion with upstream structurizr properties.
@jp7677
Update example with new property names
b253cc6
@jp7677
Update documentation with new property names
84b76c6
@jp7677 jp7677 requested a review from dirkgroot April 20, 2023 13:57
@jp7677 jp7677 merged commit 14e5d22 into avisi-cloud:main Apr 20, 2023
@jp7677 jp7677 deleted the view-property-docs branch April 20, 2023 21:14
UBessle pushed a commit to UBessle/structurizr-site-generatr that referenced this pull request Apr 23, 2023
rename flemark.extension property according to avisi-cloud#206
1e7054b
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dirkgroot dirkgroot dirkgroot approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@jp7677 @dirkgroot @qtzar