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

Ubuntu Server: OpenLDAP needs an intro summary #155

Closed
s-makin opened this issue Jan 9, 2025 · 7 comments
Closed

Ubuntu Server: OpenLDAP needs an intro summary #155

s-makin opened this issue Jan 9, 2025 · 7 comments
Assignees
Labels
edit Edit pre-existing documentation for consistency, style and application good first issue An ideal task to start with help wanted We welcome community help with this issue how-to Create a edit a how-to to achieve a specific task size 2 Fix a known documentation issue (size 2/8)

Comments

@s-makin
Copy link
Collaborator

s-makin commented Jan 9, 2025

Task

To write a short introductory paragraph for the How to Install OpenLDAP page so it's more consistent with our other "how to install" pages.

Some good examples of the style of introduction:

The introduction doesn't need to be long; a brief introduction to what OpenLDAP is, what it does and who/what it's useful for would be sufficient.

As this is a writing task, you are welcome to use the GitHub web UI and submit your pull request that way if you prefer.

This task does not require pre-knowledge of OpenLDAP. We have an explanation page in the docs specifically about OpenLDAP that you may want to consult as a starting point if you're unfamiliar with it.

Details

Full details of what's needed can be found on the Ubuntu Server issue, which was an excellent point raised by one of our readers.

Although you can claim this issue here, please make sure to submit your PR against the Ubuntu Server documentation repository.

Context

The Ubuntu Server docs were recently migrated to GitHub/Read the Docs from their previous home on Discourse. We'd be grateful for any help on several issues that will help us to finalise this and provide a better experience for our contributors and readers.

Useful links

  • Check out the Ubuntu Server contributing guide.
  • If you are new to the Canonical Open Documentation Academy, you may also want to review the Getting Started content.
  • If there are specific things you would like to learn, or want more experience on, I'm happy to bring forward other issues we have that fit with your goals.

Thanks in advance for your help!

@s-makin s-makin added good first issue An ideal task to start with help wanted We welcome community help with this issue edit Edit pre-existing documentation for consistency, style and application size 2 Fix a known documentation issue (size 2/8) how-to Create a edit a how-to to achieve a specific task labels Jan 9, 2025
@Sophie-Pages
Copy link

Hi @s-makin, I would like to work on this issue. Could you please assign it to me?
And is it okay to work on two issues as there is another one that I am interested in?

@s-makin
Copy link
Collaborator Author

s-makin commented Jan 10, 2025

Hi @s-makin, I would like to work on this issue. Could you please assign it to me? And is it okay to work on two issues as there is another one that I am interested in?

Absolutely! I've assigned it, thanks for taking it on!

Since this issue should be a fairly straightforward one I don't see a problem with working on two at once. If it feels like too much after you've started, please do let me know, there are plenty more issues in the Server docs like this so you won't be missing out :)

@Sophie-Pages
Copy link

Great thank you so much! I plan to have a first version for this week or beginning of next week at the latest!

@s-makin
Copy link
Collaborator Author

s-makin commented Jan 13, 2025

Great thank you so much! I plan to have a first version for this week or beginning of next week at the latest!

That sounds great! Let me know how you get on or if you need any help :)

@Sophie-Pages
Copy link

Sophie-Pages commented Jan 18, 2025

Hi @s-makin, I created my pull request here: canonical/ubuntu-server-documentation#119. It is a first version and I wanted it to be quite concise. If you think anything is missing or if I need to go deeper on a specific topic, please don't hesitate to tell me.

In the initial request from apb1963, they asked for disadvantages so I added the phrase "However, because of those characteristics, beginners sometimes find it difficult to apprehend or administer.".
While it is useful information, I don't like the negative aspect it brings to this introduction. What do you think?

@s-makin
Copy link
Collaborator Author

s-makin commented Jan 27, 2025

Your PR has been merged so closing this issue as completed now 🚀

Thanks again for your work on this issue @Sophie-Pages, this is just what we needed! You got exactly the right balance between concise and detailed, and it very much suits the tone of the rest of the article. If you would like to work on more Ubuntu Server issues let me know what sort of thing you're interested in and I can put up some specifically for you :)

@s-makin s-makin closed this as completed Jan 27, 2025
@Sophie-Pages
Copy link

Thank you so much @s-makin! I truly appreciate that you took the time to write this feedback! It means a lot!
Once I have completed the two issues I am working on, I would be delighted to take on more Ubuntu Server issues! I can help with having a fresh perspective, rewording, ensuring a consistent tone, or adding missing text. And I don't mind if it is technical. I am happy to help wherever it's needed!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
edit Edit pre-existing documentation for consistency, style and application good first issue An ideal task to start with help wanted We welcome community help with this issue how-to Create a edit a how-to to achieve a specific task size 2 Fix a known documentation issue (size 2/8)
Projects
None yet
Development

No branches or pull requests

2 participants