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

Site generation: RFC documents not showing HTML in site generate #297

Open
ronaldtse opened this issue Feb 2, 2023 · 3 comments
Open

Site generation: RFC documents not showing HTML in site generate #297

ronaldtse opened this issue Feb 2, 2023 · 3 comments
Assignees
Labels
bug Something isn't working

Comments

@ronaldtse
Copy link
Contributor

This blocks:

In this action:
https://github.com/CalConnect/PUBLIC_DRAFTS/actions/runs/4071026113

The generated site looks like this:
Screen Shot 2023-02-02 at 11 48 34 AM

Notice that the HTML output is missing, and therefore the title does not link anywhere:
Screen Shot 2023-02-02 at 11 49 12 AM

However, in the generated site artifact, the HTML is included:

Screen Shot 2023-02-02 at 11 49 39 AM

This is clearly a bug with the site generation code that it cannot find the generated HTML output.

@abunashir @CAMOBAP can you please help address this? Thanks.

@ronaldtse ronaldtse added the bug Something isn't working label Feb 2, 2023
@abunashir
Copy link
Member

I'm looking into it 👍🏼

abunashir added a commit to abunashir/PUBLIC_DRAFTS that referenced this issue Feb 2, 2023
The `metanorma` requires us to have `rxl` as an extension for some
standards, and if missing then it can't generate the collection in
proper way. This was one the issue for missing link.

This commit should fix the issue and it should link the internal
documents properly.

One thing to note, there is still one issue with how it handles
the `RFC`, but that is something we will address soon.

Related: metanorma/metanorma-cli#297
ronaldtse pushed a commit to CalConnect/PUBLIC_DRAFTS that referenced this issue Feb 2, 2023
The `metanorma` requires us to have `rxl` as an extension for some
standards, and if missing then it can't generate the collection in
proper way. This was one the issue for missing link.

This commit should fix the issue and it should link the internal
documents properly.

One thing to note, there is still one issue with how it handles
the `RFC`, but that is something we will address soon.

Related: metanorma/metanorma-cli#297
@abunashir
Copy link
Member

Looks like this issue similar to #257, a missing rxl extension was causing the issue. I've added a PR to address this issue. Here is how that should look like:

Screenshot 2023-02-02 at 15 57 14

But I also see one more issue with the second document draft-ietf-calext-ical-tasks.rfc.xml, which has xml extension, so I think the collection interface is picking that up but it doesn't have corresponding html or other file, so how should we process that one? what's the expected behaviour here?

Screenshot 2023-02-02 at 16 08 49

@ronaldtse
Copy link
Contributor Author

ronaldtse commented Feb 3, 2023

The .rfc.xml file is the IETF RFC XML format, which is necessary for the generation of the HTML (the HTML is generated using IETF's xml2rfc command-line tool).

Technically, the document generation process of Metanorma should provide a YAML structure for each of the files for the rendering of the mini-site, e.g.:

- file: draft-ietf-calext-ical-tasks.html
  format: html
  format_name: HTML
- file: draft-ietf-calext-ical-tasks.xml
  format: xml
  format_name: Metanorma Semantic XML
- file: draft-ietf-calext-ical-tasks.rfc.xml
  format: xml
  format_name: IETF RFC XML
...

It is also strange that we require the generation of the rxl file, this is something we have to fix. I think the document generation process should create a index.yaml file that contains the metadata of all files generated.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
Status: 🌋 Urgent
Development

No branches or pull requests

3 participants