- Notifications
You must be signed in to change notification settings - Fork 89
Compare Models #601
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
Compare Models #601
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
good start! Before this is "ready", it needs to support tokens. I can live without the delete notation comparison for version 1, but it would be a nice to have.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Some style suggestions and minor rewording.
site/compare.md Outdated
| | ||
| When working with a domain model, sometimes it is useful to know the differences between different models. | ||
| | ||
| The compare model tool compares two model files and generates a model that shows the differences between them. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
compare model tool -> Compare Model Tool
I suggest putting the second sentence right after the first one; they go together.
site/compare.md Outdated
| | ||
| The compare model tool compares two model files and generates a model that shows the differences between them. | ||
| | ||
| To use the Compare Model Tool, simply run the `compareModel` shell script with the correct arguments. To see the list of valid arguments for any tool in the Oracle WebLogic Server Deploy Tooling installation, simply run the shell script with the `-help` option (or with no arguments) to see the shell script usage information. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Suggested rewording of this sentence, "To see the list of valid arguments, simply run the shell script with the -help option (or with no arguments), which displays the shell script usage information."
site/compare.md Outdated
| | ||
| Comparing the new and old models: | ||
| | ||
| 1. Added 'cluster-2' and 'cluster-2-template' in the topology section |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In each one of these numbered statements, do the following:
- Put the syntax names in code font, for example, 'cluster-2' should be
cluster-2(use surrounding back ticks to do this). - Put a period at the end of each sentence.
site/compare.md Outdated
| 7. Changed deployment targets for application `myear` | ||
| 8. Removed the attribute 'ModuleType' for application `myear` | ||
| | ||
| Note: The `!` is a notation for the deletion of a non-attribute key element from the model. Any missing attribute will |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Make the word Note bold (surround with two asterisks).
site/compare.md Outdated
| 8. Removed the attribute 'ModuleType' for application `myear` | ||
| | ||
| Note: The `!` is a notation for the deletion of a non-attribute key element from the model. Any missing attribute will | ||
| be omitted from the result model but shown as `info` level messages in the output. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
from the result model -> from the resulting model, (comma)
site/compare.md Outdated
| 8. Removed the attribute 'ModuleType' for application `myear` | ||
| | ||
| **Note**: The `!` is a notation for the deletion of a non-attribute key element from the model. Any missing attribute will | ||
| be omitted from the resulting model, but shown as messages in the output. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Any missing attribute will be omitted from the resulting model, but shown as a message in the output.
(all singular OR all plural)
Missing attributes will be omitted from the resulting model, but shown as messages in the output.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
one more edit
This is a draft PR for the model diff - compareModel tool. It's a work in progress, there are areas that needs more work. e.g. do we allow delete certain resource like connection factory, subedeployment ... from JMSSystemResource -> i.e. generate the right notation at the particular level and what's the best way to accomplish that, right now the tool has no concept of aliases and operated solely on dictionary math.