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 #7692

Conversation

ShrushtiDesai
Copy link
Contributor

@ShrushtiDesai ShrushtiDesai commented Nov 20, 2024

This PR addresses the issue #7657.

This pull request updates the Folder Computation section of the Jenkins documentation to reflect recent UI changes in the handling of computed folders for both Multibranch Pipeline Projects and GitHub Organization Projects.

Key Updates:

  • The revised section now describes the previous functionality of Folder Computation and Branch Indexing, and clarifies the renaming and relocation of these options in the updated Jenkins version:

    • Multibranch Pipeline Projects: The Branch Indexing tab, which included Run Now and Log options, has been renamed to Scan Multibranch Pipeline Now and Scan Multibranch Pipeline Log.
    • GitHub Organization Projects: The Folder Computation tab, which included Run Now and Log options, has been renamed to Scan Organization Now and Scan Organization Log.
    • These changes followed the deprecation of the GitHub Organization Folder plugin and its integration into the Branch Source plugin.
  • Screenshots and their corresponding alt text have been updated to reflect the UI changes described in this section.

Please review the changes and let me know if further revisions are needed.

@ShrushtiDesai ShrushtiDesai requested a review from a team as a code owner November 20, 2024 19:34
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.

This change looks great and I appreciate that the Folder Computation header was kept (as this avoids any link breakage). Thank you very much @ShrushtiDesai for your work on this and for collaborating to ensure the updates are done properly.

Approving pending the format adjustments (nothing major, just a best practice)


_Multibranch Pipeline_ projects and _GitHub Organization Folders_ extend Jenkins' folder functionality by introducing computed folders, which automatically manage their contents by dynamically creating and updating child items.

* **Multibranch Pipeline Projects:** Previously, the computed folder functionality was located under the **Branch Indexing** tab, which included **Run Now** and **Log** options. Jenkins would generate child items for each eligible branch within a repository and automatically update the pipeline list as branches changed. In the updated version, these options are no longer under a specific tab and have been renamed to **Scan Multibranch Pipeline Now** and **Scan Multibranch Pipeline Log**.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
* **Multibranch Pipeline Projects:** Previously, the computed folder functionality was located under the **Branch Indexing** tab, which included **Run Now** and **Log** options. Jenkins would generate child items for each eligible branch within a repository and automatically update the pipeline list as branches changed. In the updated version, these options are no longer under a specific tab and have been renamed to **Scan Multibranch Pipeline Now** and **Scan Multibranch Pipeline Log**.
* **Multibranch Pipeline Projects:** Previously, the computed folder functionality was located under the **Branch Indexing** tab, which included **Run Now** and **Log** options.
Jenkins would generate child items for each eligible branch within a repository and automatically update the pipeline list as branches changed.
In the updated version, these options are no longer under a specific tab and have been renamed to **Scan Multibranch Pipeline Now** and **Scan Multibranch Pipeline Log**.

Suggestion to adjust formatting for one sentence per line.

computation task after a period of inactivity (this defaults to run after one
day).

_Multibranch Pipeline_ projects and _GitHub Organization Folders_ extend Jenkins' folder functionality by introducing computed folders, which automatically manage their contents by dynamically creating and updating child items.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
_Multibranch Pipeline_ projects and _GitHub Organization Folders_ extend Jenkins' folder functionality by introducing computed folders, which automatically manage their contents by dynamically creating and updating child items.
*Multibranch Pipeline* projects and *GitHub Organization Folders* extend Jenkins' folder functionality by introducing computed folders, which automatically manage their contents by dynamically creating and updating child items.

Suggestion to use bold instead of italics as these are UI terms/items.


* **Multibranch Pipeline Projects:** Previously, the computed folder functionality was located under the **Branch Indexing** tab, which included **Run Now** and **Log** options. Jenkins would generate child items for each eligible branch within a repository and automatically update the pipeline list as branches changed. In the updated version, these options are no longer under a specific tab and have been renamed to **Scan Multibranch Pipeline Now** and **Scan Multibranch Pipeline Log**.

* **GitHub Organization Projects:** Originally, the computed folder functionality appeared under the **Folder Computation** tab, with **Run Now** and **Log** options. This functionality populated repositories as individual Multibranch Pipelines and provided insights into branch and repository scans. In the updated version, these options are no longer under a tab and have been renamed to **Scan Organization Now** and **Scan Organization Log**.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
* **GitHub Organization Projects:** Originally, the computed folder functionality appeared under the **Folder Computation** tab, with **Run Now** and **Log** options. This functionality populated repositories as individual Multibranch Pipelines and provided insights into branch and repository scans. In the updated version, these options are no longer under a tab and have been renamed to **Scan Organization Now** and **Scan Organization Log**.
* **GitHub Organization Projects:** Originally, the computed folder functionality appeared under the **Folder Computation** tab, with **Run Now** and **Log** options.
This functionality populated repositories as individual Multibranch Pipelines and provided insights into branch and repository scans.
In the updated version, these options are no longer under a tab and have been renamed to **Scan Organization Now** and **Scan Organization Log**.

Suggestion to adjust formatting for one sentence per line (same as above).


* **GitHub Organization Projects:** Originally, the computed folder functionality appeared under the **Folder Computation** tab, with **Run Now** and **Log** options. This functionality populated repositories as individual Multibranch Pipelines and provided insights into branch and repository scans. In the updated version, these options are no longer under a tab and have been renamed to **Scan Organization Now** and **Scan Organization Log**.

These updates followed the deprecation of the plugin:github-organization-folder[*GitHub Organization Folder*] plugin and its integration into the plugin:github-branch-source[*GitHub Branch Source*] plugin.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
These updates followed the deprecation of the plugin:github-organization-folder[*GitHub Organization Folder*] plugin and its integration into the plugin:github-branch-source[*GitHub Branch Source*] plugin.
These updates are a result of the deprecation of the plugin:github-organization-folder[*GitHub Organization Folder*] plugin and its integration into the plugin:github-branch-source[*GitHub Branch Source*] plugin.

Small wording adjustment to avoid past tense.


These updates followed the deprecation of the plugin:github-organization-folder[*GitHub Organization Folder*] plugin and its integration into the plugin:github-branch-source[*GitHub Branch Source*] plugin.

Folder scans can be automatically triggered through webhook callbacks whenever branches or repositories are created or removed. Scans can also be configured to run periodically via the **Build Triggers** settings, which default to a re-scan after one day of inactivity.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
Folder scans can be automatically triggered through webhook callbacks whenever branches or repositories are created or removed. Scans can also be configured to run periodically via the **Build Triggers** settings, which default to a re-scan after one day of inactivity.
Folder scans can be automatically triggered through webhook callbacks whenever branches or repositories are created or removed.
Scans can also be configured to run periodically via the *Build Triggers* settings, which default to a re-scan after one day of inactivity.

Suggestion to adjust formatting for one sentence per line.

may have useful information to diagnose the problem.
image::github-organization-build-triggers-settings.png[alt = "Configuration page for the 'CloudBeersInc' project, of the GitHub Organization Folder type. In the 'Scan Organization Triggers' section the 'Periodically if not otherwise run' option is checked and the Interval is set to '1 day'.", width=80%]

The log from the last attempt to scan the organization is available in the **Scan Organization Log**. If the scan doesn’t produce the expected set of repositories, the log may contain useful information to help diagnose the issue.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
The log from the last attempt to scan the organization is available in the **Scan Organization Log**. If the scan doesn’t produce the expected set of repositories, the log may contain useful information to help diagnose the issue.
The log from the last attempt to scan the organization is available in the *Scan Organization Log*.
If the scan doesn’t produce the expected set of repositories, the log may contain useful information to help diagnose the issue.

Suggestion to adjust formatting for one sentence per line.


_Multibranch Pipeline_ projects and _GitHub Organization Folders_ extend Jenkins' folder functionality by introducing computed folders, which automatically manage their contents by dynamically creating and updating child items.

* **Multibranch Pipeline Projects:** Previously, the computed folder functionality was located under the **Branch Indexing** tab, which included **Run Now** and **Log** options. Jenkins would generate child items for each eligible branch within a repository and automatically update the pipeline list as branches changed. In the updated version, these options are no longer under a specific tab and have been renamed to **Scan Multibranch Pipeline Now** and **Scan Multibranch Pipeline Log**.
Copy link
Member

Choose a reason for hiding this comment

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

please do not include documentation for content that is many years out of date, someone reading the docs doesn't need to know information this old (looks like 8 years ago)


* **GitHub Organization Projects:** Originally, the computed folder functionality appeared under the **Folder Computation** tab, with **Run Now** and **Log** options. This functionality populated repositories as individual Multibranch Pipelines and provided insights into branch and repository scans. In the updated version, these options are no longer under a tab and have been renamed to **Scan Organization Now** and **Scan Organization Log**.

These updates followed the deprecation of the plugin:github-organization-folder[*GitHub Organization Folder*] plugin and its integration into the plugin:github-branch-source[*GitHub Branch Source*] plugin.
Copy link
Member

Choose a reason for hiding this comment

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

delete

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Hi @timja,
Do you prefer the content to exclude information about the previous UI and the plugin deprecation, and instead focus solely on describing the current UI? Let me know your thoughts so I can adjust the content accordingly.

Copy link
Member

Choose a reason for hiding this comment

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

Yes please current UI only, unless in a transition period not 8 years ago

@ShrushtiDesai ShrushtiDesai force-pushed the folder-computation-update branch from 4695b3d to 33ad404 Compare November 21, 2024 13:34
@kmartens27
Copy link
Contributor

Thank you very much @timja for the insights and feedback, I'll be keeping all that in mind going forward as well.

@ShrushtiDesai
Copy link
Contributor Author

According to the Feedback from @timja and @kmartens27 i have updated the Folder Computation as follows:

  • Removed mentioned of previous UI features.
  • Made the UI terms bold.
  • Adjusted the formatting as one sentence per line.
  • Wording adjustment to avoid past tense.

I have a couple of clarifications:

  • Regarding the formatting change to have one sentence per line: I noticed that this formatting is reflected in the code file but not on the UI page itself. Is this what you intended—having the change only in the code for better readability, without affecting the UI?
  • Should the deprecation sentence also be removed, or is it okay to keep it as is?
  • After making the changes, I see an option to force push the updates. Is it fine to proceed with a force push in this case?

@kmartens27
Copy link
Contributor

Hi @ShrushtiDesai, thank you very much for taking the time to make the necessary changes.

In terms of your questions:

  1. The practice of one sentence per line makes it easier to review and provide feedback on anything that is written. For instance, if an entire paragraph is on 1 line and there is an issue with something in the middle of the content, it is more cumbersome to provide this feedback. The UI is able to render the line breaks and formatting properly, without having to provide a massive text block. This is indeed by design.
  2. Line 89 can be removed, as @timja pointed out this transition happened long ago so it's fine to just focus on the current UI and functionality.
  3. Do not force push the changes. Make sure you fetch & pull all the changes down to your working branch and once you've done that you should be able to just push (without the force).

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.

3 participants