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

Add OMG Preface page #1011

Merged
merged 7 commits into from
Aug 7, 2024
Merged

Conversation

bact
Copy link
Collaborator

@bact bact commented Jul 25, 2024

Using text from Bob's Word doc 2024-07-22

  • Note that for the address block ("OMG Headquarters..."), two spaces at the end of each line is a Markdown convention for "newline".
    • Have to recheck if this render correctly on both HTML and PDF.
    • We can also try <br /> instead

Using text from Bob's Word doc 2024-07-22

Note that for the address block ("OMG Headquarters..."), two spaces at the end of the line is a Markdown convention for "newline". -- Have to check if this render correctly on both HTML and PDF.

Signed-off-by: Arthit Suriyawongkul <[email protected]>
@bact bact mentioned this pull request Jul 25, 2024
69 tasks
Copy link

@bobmartin3000 bobmartin3000 left a comment

Choose a reason for hiding this comment

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

LGTM

CORBA® (Common Object Request Broker Architecture); CWM™ (Common Warehouse
Metamodel); and industry-specific standards for dozens of vertical markets.

More information on the OMG is available at <https://www.omg.org/>.
Copy link
Collaborator Author

@bact bact Jul 29, 2024

Choose a reason for hiding this comment

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

@zvr Should we also convert this <link> in OMG Preface to [label](link) as well? (not sure what label we can use, because this will alter the text from OMG)

Or does it ok to leave links in this page as-is, because we should keep it verbatim?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

There are also few others.

Choose a reason for hiding this comment

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

We shouldn't render the OMG Preface page on the html version of the spec - it is only to be incorporated in the version of the spec that we bring to OMG.

Copy link
Collaborator Author

@bact bact Jul 29, 2024

Choose a reason for hiding this comment

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

Thank you.

I'm asking because I was told last time that links shouldn't be visible in a bare URL form inside a paragraph but instead there should be a link text, and an URL will be rendered as a footnote.

So instead of this paragraph:

More information on the OMG is available at <https://www.omg.org/>.

which will be rendered as:

More information on the OMG is available at https://www.omg.org/.

We should have something similar to this paragraph:

More information on the OMG is available at [the OMG website](https://www.omg.org/).

Which will be rendered something like:

More information on the OMG is available at the OMG website [2].

with [2] https://www.omg.org/ as a footnote.

Please correct me if I misunderstand this. Thank you.

(Note: If there are differences in chapters, we may need two mkdocs.yml. One for PDF and one for HTML. Will figure this out.)

See spdx/spdx-3-model#806 (review)

Signed-off-by: Arthit Suriyawongkul <[email protected]>
@bobmartin3000
Copy link

bobmartin3000 commented Jul 29, 2024 via email

Copy link
Contributor

@kestewart kestewart left a comment

Choose a reason for hiding this comment

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

Approving this for the version that goes to OMG, but does not go on the website.

@kestewart kestewart merged commit a0f3a0f into spdx:development/v3.0.1 Aug 7, 2024
3 checks passed
@bact bact deleted the add-page-OMG-preface branch August 7, 2024 13:53
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