-
Notifications
You must be signed in to change notification settings - Fork 142
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
Add OMG Preface page #1011
Conversation
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]>
There was a problem hiding this 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/>. |
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.)
Signed-off-by: Arthit Suriyawongkul <[email protected]>
Shouldn’t render the OMG Preface page in the html version – just in the version we bring to OMG as a PDF.
Bob
From: Arthit Suriyawongkul ***@***.***>
Date: Monday, July 29, 2024 at 11:26 AM
To: spdx/spdx-spec ***@***.***>
Cc: Robert A Martin ***@***.***>, Comment ***@***.***>
Subject: [EXT] Re: [spdx/spdx-spec] Add OMG Preface page (PR #1011)
@bact commented on this pull request. In docs/omg-preface. md: > +not-for-profit computer industry standards consortium that produces and +maintains computer industry specifications for interoperable, portable, and +reusable enterprise applications
@bact commented on this pull request.
________________________________
In docs/omg-preface.md<#1011 (comment)>:
+not-for-profit computer industry standards consortium that produces and
+maintains computer industry specifications for interoperable, portable, and
+reusable enterprise applications in distributed, heterogeneous environments.
+Membership includes Information Technology vendors, end users, government
+agencies, and academia.
+
+OMG member companies write, adopt, and maintain its specifications following a
+mature, open process. OMG’s specifications implement the Model Driven
+Architecture® (MDA®), maximizing ROI through a full-lifecycle approach to
+enterprise integration that covers multiple operating systems, programming
+languages, middleware and networking infrastructures, and software development
+environments. OMG’s specifications include: UML® (Unified Modeling Language™);
+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/>.
@zvr<https://github.com/zvr> Should we also convert this in OMG Preface to link as well?
—
Reply to this email directly, view it on GitHub<#1011 (review)>, or unsubscribe<https://github.com/notifications/unsubscribe-auth/AUYBD7A6SIFTIQIX4GI2ZL3ZOZNIRAVCNFSM6AAAAABLOPHCKOVHI2DSMVQWIX3LMV43YUDVNRWFEZLROVSXG5CSMV3GSZLXHMZDEMBVGI4TEOBYGM>.
You are receiving this because you commented.Message ID: ***@***.***>
|
Signed-off-by: Arthit Suriyawongkul <[email protected]>
Signed-off-by: Arthit Suriyawongkul <[email protected]>
There was a problem hiding this 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.
Using text from Bob's Word doc 2024-07-22
<br />
instead