update build tool instructions and add pointer to legacy branch#385
update build tool instructions and add pointer to legacy branch#385
Conversation
|
|
|
||
| _To build Open MCT for MCWS, the legacy product that combines Open MCT and the MCWS Plugin, see the [legacy branch](https://github.com/NASA-AMMOS/openmct-mcws/tree/legacy)._ | ||
|
|
||
| ## Building Open MCT using the MCWS Plugin |
There was a problem hiding this comment.
I think we can get rid of this section? just move this last sentence: "The MCWS Plugin is then included and customized in build tool configuration." after the first sentence in "Getting Started and Installation Instructions". Otherwise it's a little redundant with mentioning the build tool and required access twice.
There was a problem hiding this comment.
re-arranged some stuff
| Open MCT is built using the [Open MCT Build Tool](https://github.com/akhenry/openmct-build) (requires access request). The MCWS Plugin is then included and customized in build tool configuration. | ||
|
|
||
| ### Installing the Build Tool | ||
| Install the [Open MCT Build Tool](https://github.com/akhenry/openmct-build) (requires access request). Therein contains instructions for how to use and configure Open MCT using the build tool. |
There was a problem hiding this comment.
I almost think we can do the same with this section. Move the last sentence up to the first section:
Getting Started and Installation Instructions
Installing the MCWS Plugin with Open MCT requires building Open MCT using the Open MCT Build Tool (requires access request). The MCWS Plugin is then included and customized in build tool configuration. The build tool contains instructions for how to use and configure Open MCT.
something like that? just a suggestion. Just seems like a lot of redundancy otherwise.
There was a problem hiding this comment.
re-arranged some stuff
| mct build | ||
| ``` | ||
|
|
||
| ### MCWS Plugin via Build Tool recipe |
There was a problem hiding this comment.
maybe mention the yaml is in the build tool repo here?
There was a problem hiding this comment.
lol, nevermind, I see you've included it below, still can't hurt to mention though, up to you.
There was a problem hiding this comment.
i think we can polish it up once we know where things will exist
jvigliotta
left a comment
jvigliotta
left a comment
There was a problem hiding this comment.
This is great man. Nice work. I commented a couple of suggestions, let me know if you wanna chat about it. Up to you if you want to take action on it.
@jvigliotta , ready for re-review |
2 participants
No description provided.