Update Add Product Guide #10533
Update Add Product Guide #10533
Conversation
openshift-ci
bot
added
the
do-not-merge/work-in-progress
|
Skipping CI for Draft Pull Request. |
|
Start a new ephemeral environment with changes proposed in this pull request: Fedora Environment Oracle Linux 8 Environment |
openshift-ci
bot
removed
the
do-not-merge/work-in-progress
Mab879
force-pushed
the
add_product_docs_update
branch
from
b5285bf
to
400f659
Compare
There was a problem hiding this comment.
Hello @Mab879 and thank you for this update, it is really helpful because I can imagine it can cause pain for those who try to add new products.
I think that some changes are not needed. Please see my comments.
| @@ -411,8 +411,8 @@ MAKEFILE_ID_TO_PRODUCT_MAP = { | |||
|
|
|||
|
|
|||
| 5. Create a new file in the product directory called `CMakeLists.txt`: | |||
| ``` | |||
There was a problem hiding this comment.
Not sure why this line is changed... I think it should stay the same.
| @@ -411,8 +411,8 @@ MAKEFILE_ID_TO_PRODUCT_MAP = { | |||
|
|
|||
|
|
|||
| 5. Create a new file in the product directory called `CMakeLists.txt`: | |||
| ``` | |||
| cat << EOF >> $NEW_PRODUCT/CMakeLists.txt | |||
There was a problem hiding this comment.
I see multiple instances of such changes in this PR. But I think they are not correct - this command is using Bash heredoc to insert contents into a file and the change you propose breaks it.
Heredoc is denoted with <<.
https://www.howtogeek.com/719058/how-to-use-here-documents-in-bash-on-linux/
| @@ -437,7 +437,7 @@ pkg_manager: "yum" | |||
|
|
|||
There was a problem hiding this comment.
@Mab879 I think additional .. needs to be here.
There was a problem hiding this comment.
The update you requested should be in now.
|
Code Climate has analyzed commit 42d7ed4 and detected 0 issues on this pull request. The test coverage on the diff in this pull request is 100.0% (50% is the threshold). This pull request will bring the total coverage in the repository to 52.5% (0.1% change). View more on Code Climate. |
Description:
Update add products guide.
Rationale:
Make life easier for developers.