Skip to content

Expand glossary with new terms and definitions - Letter R, I,#451

Open
MariaBego56 wants to merge 1 commit intocanonical:mainfrom
MariaBego56:patch-16
Open

Expand glossary with new terms and definitions - Letter R, I,#451
MariaBego56 wants to merge 1 commit intocanonical:mainfrom
MariaBego56:patch-16

Conversation

@MariaBego56
Copy link
Contributor

Description

Expanded and added definitions mainly for letter R, but also some in B, I, and N
Added definitions for BaseDN, BindDN, IP address, LDAP, Non-routable, ROM, rootDN, rootfs, rootPW, and routable.

Related Issue

If this pull request addresses an existing issue, please link to it below. Use the Fixes #<issue-number> syntax to
close the issue automatically when the pull request is merged.

Example:

  • Fixes: #1234

Contributor License Agreement (CLA)

By contributing to this project, you agree to the terms of
the Canonical Contributor License Agreement (CLA).
If you have not already signed the CLA, please do so here.


Commit Message for Squash Merge

We typically squash commits when merging. You can specify the commit message that should be used in this case if you wish.
Provide the desired commit message below:

[(optional) category] Brief description of changes made, and why


Checklist

  • I have read and followed the Ubuntu Server contributing guide.
  • [ x] My pull request is linked to an existing issue (if applicable).
  • [ x] I have tested my changes, and they work as expected.

Additional Notes (Optional)

Add any extra information or context that reviewers may need to know. This could include testing instructions,
screenshots, or links to related discussions.


Thank you for contributing to the Ubuntu Server documentation!

Added definitions for BaseDN, BindDN, IP address, LDAP, Non-routable, ROM, rootDN, rootfs, rootPW, and routable.
Copy link
Collaborator

@s-makin s-makin left a comment

Choose a reason for hiding this comment

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

Hi @MariaBego56, I'm so sorry for the slow response, I completely missed this PR!

Thank you for your hard work continuing to fill in the glossary. I really like how concise you've been able to make these descriptions. It's not easy at all!

I've left some suggestions inline - mostly it's to remove the cross-linking between terms in the glossary. The "related terms" is intended to be for whatever the parent topic is in the Server docs so users know which section is most relevant to what they're looking up.

I've also suggested trimming down the "see also" links because having long lists makes it harder for users to chase down the relevant information they're looking for. Ideally, we would try to keep the reader inside the documentation, so we should provide a link to the most relevant page in the Server docs where we have one, then if we don't have one, a link to the official Upstream documentation, and if you can't find official docs (e.g. for conceptual things) then wikipedia is fine. I've left suggestions for replacements if that helps!

Please let me know if I can clarify any of these points :)

Comment on lines +348 to +351
* {term}`BindDN`
* {term}`rootPW`
* {term}`rootDN`

Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
* {term}`BindDN`
* {term}`rootPW`
* {term}`rootDN`
* OpenLDAP


BindDN
*Work in Progress*
Bin Distinguished Name
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
Bin Distinguished Name
Bind Distinguished Name

BindDN
*Work in Progress*
Bin Distinguished Name
BinDN is the account credentials you use to connect to {term}`LDAP`. The "login name" in LDAP's Distinguished Name format.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
BinDN is the account credentials you use to connect to {term}`LDAP`. The "login name" in LDAP's Distinguished Name format.
BindDN is the account credentials you use to connect to {term}`LDAP`. The "login name" in LDAP's Distinguished Name format.

Comment on lines +364 to +366
* {term}`BaseDN`
* {term}`rootPW`
* {term}`rootDN`
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
* {term}`BaseDN`
* {term}`rootPW`
* {term}`rootDN`
* OpenLDAP

Comment on lines +1253 to +1254
* [Types of IP addresses](https://en.wikipedia.org/wiki/IP_address) and also (https://surfshark.com/blog/types-of-ip-addresses?srsltid=AfmBOootFd41l6RuqpGZR5Zxwm-3ervwdkWxvXLyJbRtRGxNmhdiTrmk)
* [IP address functions](https://en.wikipedia.org/wiki/IP_address)
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
* [Types of IP addresses](https://en.wikipedia.org/wiki/IP_address) and also (https://surfshark.com/blog/types-of-ip-addresses?srsltid=AfmBOootFd41l6RuqpGZR5Zxwm-3ervwdkWxvXLyJbRtRGxNmhdiTrmk)
* [IP address functions](https://en.wikipedia.org/wiki/IP_address)
* [Types of IP addresses](https://en.wikipedia.org/wiki/IP_address)

Copy link
Collaborator

Choose a reason for hiding this comment

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

We only need to show the one link here :)

Comment on lines +1993 to +1996
Related topic(s):
* {term}`BaseDN`
* {term}`BindDN`
* {term}`rootPW`
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
Related topic(s):
* {term}`BaseDN`
* {term}`BindDN`
* {term}`rootPW`
Related topic(s):
* OpenLDAP

rootfs
Root File System
*Work in Progress*
rootfs is the top-level filesystem that contains all the essential files needed to boot and run a Linux/Unix system. It is the foundation upon what everthing else is built.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
rootfs is the top-level filesystem that contains all the essential files needed to boot and run a Linux/Unix system. It is the foundation upon what everthing else is built.
rootfs is the top-level filesystem that contains all the essential files needed to boot and run a Linux/Unix system. It is the foundation everything else is built upon.

Comment on lines +2002 to +2004
See also:
* [Types of roofs](https://refspecs.linuxfoundation.org/FHS_3.0/fhs/ch03.html)
* [Boot process and rootfs](https://www.youtube.com/watch?v=XpFsMB6FoOs)
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
See also:
* [Types of roofs](https://refspecs.linuxfoundation.org/FHS_3.0/fhs/ch03.html)
* [Boot process and rootfs](https://www.youtube.com/watch?v=XpFsMB6FoOs)


rootPW
Root Password
rootPW is the administrative password that grants full access to the rootDN account. RootPW and {term}`rootDN gives full administrative access to {term}`LDAP`
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
rootPW is the administrative password that grants full access to the rootDN account. RootPW and {term}`rootDN gives full administrative access to {term}`LDAP`
rootPW is the administrative password that grants full access to the rootDN account. RootPW and rootDN give full administrative access to LDAP.

Comment on lines +2013 to +2015
Related topic(s):
* {term}`non-ruotable`
* {term}`IP address`
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
Related topic(s):
* {term}`non-ruotable`
* {term}`IP address`

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.

2 participants