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

md2html.sh - Make sure there is no CRLF #60

Merged
merged 1 commit into from
Apr 5, 2021

Conversation

nhosoi
Copy link
Contributor

@nhosoi nhosoi commented Apr 5, 2021

No description provided.

Copy link
Contributor

@richm richm left a comment

Choose a reason for hiding this comment

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

lgtm

@richm richm merged commit 035ecb9 into linux-system-roles:master Apr 5, 2021
@pcahyna
Copy link
Member

pcahyna commented Apr 5, 2021

Why is the .html file part of the collection artifact for Galaxy/Automation Hub? I thought that Automation Hub renders the original .md files and does not care about .html. Would it be possible to build the .html files only after building the collection artifact?
(One effect would be that collection installed from AH or Galaxy would not have the .html files. Is it usual to have such files or not?)

@nhosoi
Copy link
Contributor Author

nhosoi commented Apr 5, 2021

Why is the .html file part of the collection artifact for Galaxy/Automation Hub? I thought that Automation Hub renders the original .md files and does not care about .html. Would it be possible to build the .html files only after building the collection artifact?
(One effect would be that collection installed from AH or Galaxy would not have the .html files. Is it usual to have such files or not?)

This is for fixing these errors in the Automation Hub import.

ERROR: README.html:0:0: use "\n" for line endings instead of "\r\n" 
ERROR: roles/certificate/README.html:0:0: use "\n" for line endings instead of "\r\n" 
ERROR: roles/crypto_policies/README.html:0:0: use "\n" for line endings instead of "\r\n" 
ERROR: roles/ha_cluster/README.html:0:0: use "\n" for line endings instead of "\r\n" 
ERROR: roles/kdump/README.html:0:0: use "\n" for line endings instead of "\r\n" 
8< ------------------------------------------------------------------------ >8

@pcahyna
Copy link
Member

pcahyna commented Apr 6, 2021

Why is the .html file part of the collection artifact for Galaxy/Automation Hub? I thought that Automation Hub renders the original .md files and does not care about .html. Would it be possible to build the .html files only after building the collection artifact?
(One effect would be that collection installed from AH or Galaxy would not have the .html files. Is it usual to have such files or not?)

This is for fixing these errors in the Automation Hub import.

ERROR: README.html:0:0: use "\n" for line endings instead of "\r\n" 
ERROR: roles/certificate/README.html:0:0: use "\n" for line endings instead of "\r\n" 
ERROR: roles/crypto_policies/README.html:0:0: use "\n" for line endings instead of "\r\n" 
ERROR: roles/ha_cluster/README.html:0:0: use "\n" for line endings instead of "\r\n" 
ERROR: roles/kdump/README.html:0:0: use "\n" for line endings instead of "\r\n" 
8< ------------------------------------------------------------------------ >8

I know and I am pointing out that by leaving out the .html files from the collection, the errors would be solved. My question was whether that would be a good solution.

@nhosoi
Copy link
Contributor Author

nhosoi commented Apr 6, 2021

I know and I am pointing out that by leaving out the .html files from the collection, the errors would be solved. My question was whether that would be a good solution.

??? Aren't we supposed to convert the README.md files to the html format and package them? I think it was pointed out by @xjezda00 in his verification effort and we fixed in this bz.
6) The collection READMEs are not being converted to html nor copied / linked to /usr/share/doc/rhel-system-roles. Nor tagged as docfiles in the RPM metadata.

@richm
Copy link
Contributor

richm commented Apr 6, 2021

I know and I am pointing out that by leaving out the .html files from the collection, the errors would be solved. My question was whether that would be a good solution.

??? Aren't we supposed to convert the README.md files to the html format and package them? I think it was pointed out by @xjezda00 in his verification effort and we fixed in this bz.
6) The collection READMEs are not being converted to html nor copied / linked to /usr/share/doc/rhel-system-roles. Nor tagged as docfiles in the RPM metadata.

Yes. The html format files are supposed to be in the rpm package. The question is - do we need them in the collection for Automation Hub?

@nhosoi
Copy link
Contributor Author

nhosoi commented Apr 6, 2021

Yes. The html format files are supposed to be in the rpm package. The question is - do we need them in the collection for Automation Hub?

Ah, ok. Let me try dropping them and importing to Automation Hub. Thanks, @pcahyna and @richm.

@nhosoi nhosoi deleted the md2html branch April 20, 2021 23:16
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