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

Manage Users Documentation added #5980

Closed
wants to merge 17 commits into from
Closed

Manage Users Documentation added #5980

wants to merge 17 commits into from

Conversation

BhaswatiRoy
Copy link

@BhaswatiRoy BhaswatiRoy commented Jan 29, 2023

Fix: #5884

@BhaswatiRoy BhaswatiRoy requested a review from a team as a code owner January 29, 2023 08:16
@probot-autolabeler probot-autolabeler bot added the documentation Jenkins documentation, including user and developer docs, solution pages, etc. label Jan 29, 2023
Copy link
Contributor

@kmartens27 kmartens27 left a comment

Choose a reason for hiding this comment

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

Hi @BhaswatiRoy, thanks for your work on this. I have reviewed the documentation and suggested some changes for syntax and formatting. I also provided a link to the asciidoc reference that I use, as it has some helpful insight on page and text formatting.

The folder of images should be added into the content/doc/book/resources folder, as opposed to the document folder.

content/doc/book/managing/users.adoc Outdated Show resolved Hide resolved
content/doc/book/managing/users.adoc Outdated Show resolved Hide resolved
content/doc/book/managing/users.adoc Outdated Show resolved Hide resolved
@BhaswatiRoy
Copy link
Author

Hello @kmartens27, I have accepted the suggested changes.
I added the images to the correct folder, but the images are not showing even after adding the absolute path.
Could you possibly suggest some changes in the file path setting for fixing that?

@kmartens27
Copy link
Contributor

Hi @BhaswatiRoy, thanks for all of the updates! it appears that there was an issue where the build failed and unfortunately, this means that the preview site is unavailable. Would you be able to update the branch and make sure that it builds fully?

@kmartens27
Copy link
Contributor

Hi @BhaswatiRoy, I was reading over the PR again, and found a few oddities. Specifically, there is no need to add the readme file. Also, I would advise against adding a separate folder for the manage users images that have been uploaded. There is an existing "managing" folder in the "resources" folder, so the images can simply be added there.

I also found that the list of terms started out using the :: description list formatting, but after the first item the list changed to just being

  • item - description
  • item 2 - description 2
    It would be better to make the whole list a descriptive list format. Let me know if you have any questions on this!

@kmartens27
Copy link
Contributor

Hi @BhaswatiRoy, I have some feedback/suggestions to provide and was wondering if you would be okay with me submitting the changes to the document itself as a commit? I wanted to check before making any updates so nothing is a surprise. Thanks!

@BhaswatiRoy
Copy link
Author

BhaswatiRoy commented Feb 18, 2023

Hello @kmartens27
yes, you can definitely make the changes.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Jenkins documentation, including user and developer docs, solution pages, etc.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

jenkins.io - Add Manage Users documentation
2 participants