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

Folder Computation documentation needs update #7657

Open
kmartens27 opened this issue Nov 4, 2024 · 4 comments
Open

Folder Computation documentation needs update #7657

kmartens27 opened this issue Nov 4, 2024 · 4 comments
Labels
documentation Jenkins documentation, including user and developer docs, solution pages, etc.

Comments

@kmartens27
Copy link
Contributor

Describe your use-case which is not covered by existing documentation.

Currently, the Pipeline as Code documentation discusses Folder Computation. The issue is that this is not referred to in the Jenkins UI. The UI/process has changed and updated the name to now be Scan or Scan Organization Log, where it was previously Folder Computation. In addition to screenshot updates, this entire section's text would need to be adjusted to match, as well as creating a folder computation anchor to this section so that anything using the existing https://www.jenkins.io/doc/book/pipeline/pipeline-as-code/#folder-computation link would not be broken.

Reference any relevant documentation, other materials or issues/pull requests that can be used for inspiration.

This was first discovered with the work from #7653 updating Pipeline UI screenshots. Since the screenshots would not match the text, we decided to separate this specific section and create an issue.

Are you interested in contributing a fix?

I am interested in helping with the fix, along with @ShrushtiDesai who was working on screenshots for the Pipeline documentation.

@kmartens27 kmartens27 added the documentation Jenkins documentation, including user and developer docs, solution pages, etc. label Nov 4, 2024
@Mr-TAGORE3944
Copy link

Hi @kmartens27 ,

Thanks for outlining the issue so clearly! I’d be happy to help with updating the documentation to reflect the new terminology and UI changes. I can start by working on the text adjustments to replace "Folder Computation" with "Scan" or "Scan Organization Log" as appropriate, and I’ll ensure the screenshots align with the updated terms.

I’ll also set up an anchor link for “Folder Computation” to avoid breaking any existing references. I’ll coordinate with @ShrushtiDesai to ensure our updates are consistent and capture all necessary changes.

Let me know if there’s any specific guidance or if I should be aware of any other related sections to check.

Looking forward to contributing!

@kmartens27
Copy link
Contributor Author

kmartens27 commented Nov 7, 2024

Hi @Mr-TAGORE3944, thank you for sharing your interest in working on this!

In terms of what to look out for, I would say just take notes as you go through the configuration so you know which text needs to be updated. If it seems like the entire section needs to be reworked, I'm happy to help with the rewriting.

For the link, it may be worth creating an attribute within the documentation. The attribute would allow you to create a sort of anchor that can retain the original https://www.jenkins.io/doc/book/pipeline/pipeline-as-code/#folder-computation URL.

Please reach out if you have any questions or concerns as you go progress, and if this is your first time contributing to the Jenkins project, our contributing guide has information on how to fork and work on your jenkins.io clone repo.

@ShrushtiDesai
Copy link
Contributor

Hi @kmartens27,

I’ve been looking into the specific version of Jenkins where the Folder Computation feature was initially introduced to better understand its evolution and guide necessary documentation updates. I checked the Jenkins release changelog but couldn’t find any explicit references to Folder Computation.

Based on the date in the screenshot, it seems that Jenkins 1.639 was the version used.

It would be helpful to know if there were any subsequent versions where this feature was modified or removed, as this will assist in updating the documentation accurately.

@kmartens27
Copy link
Contributor Author

Hi @ShrushtiDesai, I did the same search to try and find out if there was a specific release where this was updated, but could not find a specific Jenkins release that included this change.

I did find a JIRA issue referring to this, which indicates that it was updated as a result of the GitHub Organization Folder plugin. However, this plugin has since been deprecated and its functionality is now included in the GitHub Branch Source plugin. Again, there doesn't seem to be a specific entry in that changelog where the JIRA is mentioned, but it may not have been something intended to include in the changelog.

I don't believe the steps/process changed much for users, as one would still need to configure the organization folder/repository as described and you would access the scans in a similar workflow. However, if there are more drastic changes needed, we can address them accordingly.

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

No branches or pull requests

3 participants