fix ePUB Renders. - Githubissues

OWASP / www-project-machine-learning-security-top-10

OWASP Machine Learning Security Top 10 Project

http://owasp.org/www-project-machine-learning-security-top-10/

Other

67 stars 22 forks source link

fix ePUB Renders. #129

Closed msnishanth9001 closed 8 months ago

msnishanth9001 commented 10 months ago

this PR contains fix to #99 and #128

Workflow to automate mirror to the https://mltop10.info/ host GitHub repo.
Fixes MD files, so the ePUB renders without errors.
Fixes alignment of tables.

note, the data in table arrangement is not good so the ePUB variant has jumbled data. This can be revisited once the tabular data is fixed.

msnishanth9001 commented 10 months ago

Note, this requires a GitHub token of the MLTOP10 Repo, saved with name COPY_TOKEN to do the WF push.

shsingh commented 10 months ago

this PR contains fix to #99 and #128

Workflow to automate mirror to the https://mltop10.info/ host GitHub repo.

Fixes MD files, so the ePUB renders without errors.

Fixes alignment of tables.

note, the data in table arrangement is not good so the ePUB variant has jumbled data. This can be revisited once the tabular data is fixed.

Hi @msnishanth9001 thanks for the PR.

Is the intent of this PR to mirror or to fix formatting issues? Or both?

At this stage the repo for https://mltop10.info is done manually because it needs a manual run of 'quarto' to generate the files.

The rendering of EPUB and PDF at this stage is more critical then worrying about the mirroring portion IMHO.

msnishanth9001 commented 10 months ago

Hi @shsingh can you please assign me this issue.

The intent is to do both fix mirror and formatting issues. Once the formatting issue is fixed the ePUB generation will be fixed.

the following WF PR will publish ePUB and PDF.

https://github.com/mltop10-info/mltop10.info/pull/4

msnishanth9001 commented 10 months ago

updated PR to remove WF for mirror.

This fixes ePUB and PDF render only.

shsingh commented 10 months ago

Hi @msnishanth9001 as your change is only for the _quarto.yml file did you want to add that as a PR to the mltop10-info repo instead?

The _quarto.yml file is not contained under docs/ in this project repository

msnishanth9001 commented 10 months ago

was using it to test the renders, forgot to remove. Done now.

shsingh commented 10 months ago

Hi @msnishanth9001,

The files look like they have gone back to cfc455f7b7cb8cdac19e46d2321090e9085f619c

Will they work properly on both the OWASP site as well as render PDF on https://mltop10.info site?

msnishanth9001 commented 10 months ago

The files look like they have gone back to https://github.com/OWASP/www-project-machine-learning-security-top-10/commit/cfc455f7b7cb8cdac19e46d2321090e9085f619c

I have rebased the commit.

Will they work properly on both the OWASP site as well as render PDF on https://mltop10.info/ site?

yes. https://mltop10.info/ site needs this PR integrated. https://github.com/mltop10-info/mltop10.info/pull/6.
ePUB file to verify ePUB render available on my fork. > https://github.com/msnishanth9001/mltop10.info/blob/epub-fixes/docs/OWASP-Machine-Learning-Security-Top-10.epub
for the fix to actually take effect you would have to run > quarto render and upload the new ePUB and PDF files.
this WF is to make renders and upload new ePUB and PDF renders every time there is a change in MD files. https://github.com/mltop10-info/mltop10.info/pull/4

shsingh commented 8 months ago

Hi @msnishanth9001 I am not sure what is being commited in this PR anymore as the files only show the GH issues. Are please you able to see if you can send another PR with the proposed changes you had?