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

DevGuide Cleanup and Improvments #4281

Merged
merged 10 commits into from Sep 26, 2023

Conversation

iguessthislldo
Copy link
Member

  • Changed doccon syntax highlighting to batch. doccon was the wrong choice because it was for DOS/batch sessions, not actual batch commands.
  • Added more use of OS-specific content tabs and they will now be automatically selected based on the browser's user agent.
  • Restructured parts of DDS Security page and expanded documentation of some XML security document elements, especially fnmatch expressions.
  • Simplified anchors at the top of devguide sections.
  • OMG specification section references can now be linked to that section in the specification PDF using :omgspec:.
  • Removed references to numbered tables and figures left over from the devguide conversion process.

- Security Section
  - Moved building instructions to building/index.
  - Restructured to make governance and permissions sections more consistent
  - Document fnmatch expressions
- Simplified anchors at the top of devguide sections.
- Formatting in alternate_interfaces_to_data
- Fixed minor typos
Also added news and converted opendds_idl options from a table.
So the merge works
Comment on lines 117 to 118
- Xerces-C++ v3.x
- OpenSSL v1.0.2+, v1.1, or v3.0.1+
Copy link
Contributor

Choose a reason for hiding this comment

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

Should we consider moving these to some kind of file or is this the only file that contains these versions?

Future work.

Copy link
Member Author

Choose a reason for hiding this comment

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

This information is already in the dependencies, so I will just link to Xerces and OpenSSL there. In the future though most of what I added here should probably be generalized and maybe moved to dependencies.

Copy link
Member Author

Choose a reason for hiding this comment

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

Yeah, thinking about it more, unless it's trivial like package names or a special case, I don't really want to be in the business of telling people how to build and install FOSS that isn't ours.

docs/building/index.rst Outdated Show resolved Hide resolved
docs/building/index.rst Outdated Show resolved Hide resolved
docs/building/index.rst Outdated Show resolved Hide resolved
docs/building/index.rst Outdated Show resolved Hide resolved
docs/devguide/alternate_interfaces_to_data.rst Outdated Show resolved Hide resolved
docs/internal/docs.rst Outdated Show resolved Hide resolved
docs/internal/docs.rst Show resolved Hide resolved
docs/devguide/introduction.rst Outdated Show resolved Hide resolved
iguessthislldo and others added 2 commits September 22, 2023 17:24
Co-authored-by: Justin Wilson <wilsonj@unityfoundation.io>
@iguessthislldo iguessthislldo merged commit 9133a16 into OpenDDS:master Sep 26, 2023
3 checks passed
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.

None yet

2 participants