Create a Post
cancel
Showing results for 
Search instead for 
Did you mean: 
MatanYanay
Employee
Employee

New documentation format for Jumbo SK

Hi All,

We are happy to update that starting 01 May 2022, our Jumbo Hotfix documentation has been modified and re-designed to a new HTML format to provide a better user experience and search capabilities.

Update of 23 May 22

  • We have added the “List of All Resolved Issues and New Features” page to both Jumbo and SmartConsole documents for all versions:
    Stella_Sh_0-1653309922474.jpeg
    It contains all fixes from all previously released Takes/Builds and allows to use the Ctrl+F search together with the embedded search filter for the entire table:
    Stella_Sh_1-1653309946205.jpeg
    “List of All Resolved Issues and New Features” is defined as the start page of each document.
  • You can download the list of all resolved issues as CSV file:
    Stella_Sh_2-1653309962023.jpeg

  • “List of Takes” was moved to the top of “List of All Resolved Issues and New Features”:Stella_Sh_3-1653309983455.jpeg

 

Notes:

  • You can access the new HTML documents from the original Jumbo Hotfix SK articles or from the “Release Map” SK article.
  • These documents support mobile devices:
    • TOC hides in the top left corner
    • You can scroll right and left in wide tables
  • The built-in search in these documents supports:
    • exact search (enclose the string in double quotes)
    • logical operators AND, OR, NOT, XOR
    In the TOC, refer to the last entry "How to Search in this Book":
    How-to-Search.png
  • You can export the list of fixes in a Take to a CSV file (works on mobile devices as well).
    Click the "Download CSV" button above the top right corner of the table.
    Download-CSV.png
  • To report specific issues in these documents, at the top of each page,
    click the 2nd button from the right on the topic toolbar:
    Feedback.png
  • If in the past you subscribed to the RSS feed in the original Jumbo Hotfix SK articles,
    then you need to subscribe to the new RSS feed in each new HTML document (for each version).
    At the top of each page, click the right-most button on the topic toolbar:
    RSS.png

Thank you

Release Operation Group and Knowledge Management Group

(4)
58 Replies
G_W_Albrecht
Legend
Legend

Straight into wikipedia would have been the better path to knowledge 😎 !

CCSE CCTE SMB Specialist
RS_Daniel
Advisor

Still no search results from my site:

 

Captura de pantalla 2022-05-03 121328.jpg

Captura de pantalla 2022-05-03 121430.jpg

0 Kudos
MatanYanay
Employee
Employee

@G_W_Albrecht  and @RS_Daniel please try now

please make sure to look on the documentation tab and not on the secure knowledge tab  

@RS_Daniel in your seconf screen short if you will go to the documentation tab you can see 4 in the results, this is our Jumbo documentations articles 

Thanks 

 

0 Kudos
S_E_
Advisor

Hi,

I did not find PRHF-19450 or PRJ-37606 in CP usercenter.

Using google it is the first match which is a "better user experience and search capabilities".

Regards

G_W_Albrecht
Legend
Legend

PMTR-82069.png

CCSE CCTE SMB Specialist
0 Kudos
MatanYanay
Employee
Employee

Unfortunately this morning we saw the sync / index issue reproduced again after it was solved last night 

We are working to fix it and once it will be fix i will update

my apologies for the inconvenience

Matan

0 Kudos
MatanYanay
Employee
Employee

Hi all

should be OK now

I hope we will not have the sync / index issues anymore  

Matan.

0 Kudos
JozkoMrkvicka
Leader
Leader

When we can expect to have all fixes from all Takes on one page ? It is nonsense to check dozens of tabs for each specific Take just to see in which exact Take some issue was fixed. For example, I often use Windows Ctrl+f search to find specific word in the page. I am sorry but I dont trust that build-in search mechanism...

Kind regards,
Jozko Mrkvicka
Florian_Schneid
Participant

Yes agree, the one pager was a way better user experience

0 Kudos
Phil_Harmonic
Participant

I have to echo the other comments on this thread and say I'm not a fan of the new format at all.

Whilst the previous iteration was by no means perfect, it made searching for PRJs and Take versions much easier than it does now via the documentation tab. You mentioned that the new documentation format provides a better user experience and search capabilities, but I disagree, and think the old model provided this with all the information presented in one page.

Ben_Dunkley
Contributor

From a quick scan of the replies, it seems I'm not alone in disliking this change.

It makes it massively harder to search the list, and work with this documentation, taking something that was previously a quick grep through the list, and changing it into a hundred-click odyssey.

If the stated aim is to "provide a better user experience and search capabilities." - then it feels like a step backwards on both points, and the end result seems to be making information more difficult to find.

(I really hope the driver here is not some sort of mobile-centric twaddle...)

(Although making search harder seems to be a theme of late - check point related google searches have become noticeably worse over the last few months - I'm assuming some content sources being purged or similar).

(Edit: Maybe a quick fix would be a link on the first page to the old sk article - might keep both camps happy?)

the_rock
Champion
Champion

I wont disagree, meaning, I agree : - ). Having said that, give it some time, Im SURE it will become better with time, like anything new.

0 Kudos
Ben_Dunkley
Contributor

Somewhat hilariously, the new format is not so bad when there's a small number of releases, for example on the R81.10 SmartConsole releases page, but gets more unwieldy and frustrating the more releases there are, when that was the scenario that they said they were attempting to fix (the scenario when the page gets too long/large that is).

(Still worse than before, but at least not actively terrible in the way it is for the bigger jumbo hfa articles).

0 Kudos
Uri_Lewitus
Employee
Employee

Hi Ben

Can you please share your specific use case? some jumbo HFs may contain hundreds of entries. which can impose a technical issue for browsers (part of the decision to change the format)
Would a CSV containing all of the entries help?



0 Kudos
JozkoMrkvicka
Leader
Leader

Did I get it correctly that instead of making less buggy Check Point software, the solution would be to "hide" the bugs for specific version ? So many bugs that browsers are not able to load the page with all the resolved issues ? Instead of doing proper QA and extensive heavy testing before releasing the new product or jumbo, the solution would be new jumbo landing page. Well . . .

Kind regards,
Jozko Mrkvicka
0 Kudos
(1)
Uri_Lewitus
Employee
Employee

Wow, that is one way to look at it.

Another one would be that we are transparent.

Just saying

0 Kudos
G_W_Albrecht
Legend
Legend

How can you hide a bug for a specific version that had been experienced by customers ? Better mark jokes as jokes, as this one sounds very offensive and should be removed for good for only containing a momentary lapse of reason 😎

CCSE CCTE SMB Specialist
Ben_Dunkley
Contributor

Hi Uri,

In terms of use case, I guess there are a few main ways that I reference the jumbo hfa documentation:

  • Routine patching - review the list of changes between the current installed HFA version and the current GA HFA version.
    (In this case, depending on the interval since the last patch, there may be several jumbo releases to review).
  • Investigations - i.e. I'm seeing some odd behaviour, is this a known thing that is referenced in the known issues and can be fixed by installing the jumbo, or do I need to log a ticket with TAC? (either resolved or not)
    In this case I'm generally wanting to search the list for a particular keyword, e.g. VPN, SecureXL, etc.
  • General keeping up to date - I sometimes find it useful to review the list or resolved issues to be aware of issues that I may not have encountered (or sometimes "Oh, that sounds like that minor glitch we've seen" etc)
    Most importantly for this one, there are the new features that creep into the jumbos these days, it's useful to be kept abreast of these, and not get surprised by them in front of a customer!

The download csv button on the new format page is potentially a step in the right direction, but somewhat unhelpful in the current state - the CSV that is produced appears to be a specific CSV for that particular take, and yet does not state in the CSV what take (or even what major/minor version) it relates to. So this would also involve downloading multiple CSV files (presumably all identically named as "JHF_Take.csv" ?) and then messing about to stitch them together with appropriate supporting information (e.g. take & version numbers etc).

I've not previously encountered any browser related errors relating to the size of the old format sk's, although it's extremely rare that I'm viewing this kind of content on a mobile device, if that's a factor. About the closest I get to browser problems with sk articles is ones where there are a lot of hidden folds (i.e. the 'click this bit to expand/view the detail for this section'), although that's merely because it can be frustrating to deal with the hide/unhide mechanism sometimes, not because of any errors.

G_W_Albrecht
Legend
Legend

My current Status: UC searches have SKs and IDs neatly indexed by now.

CCSE CCTE SMB Specialist
0 Kudos
Kris_Pellens
Collaborator

What's also missing is the list of upcoming fixes! Can that be included.

Many thanks.

0 Kudos
Stella_Sh
Employee
Employee

We will publish the list of upcoming resolved issues, just like we did before, as soon as it will be ready.

0 Kudos
G_W_Albrecht
Legend
Legend

It seems the new format did not succeed - CP is back to pure text-based listing format - see in Support Center Notifications: 2022-05-15 e.g.:

R81.10 SmartConsole Releases
Jumbo Hotfix Accumulator for R81.10
R80.30 SmartConsole Releases
Jumbo Hotfix Accumulator for R81

 Must be on purpose as the links end in an explicit &xtn=.txt ! 😎

CCSE CCTE SMB Specialist
Uri_Lewitus
Employee
Employee

Thanks for reporting this Guenther, this is obviously not the expected behavior, we are looking into it.

0 Kudos
Uri_Lewitus
Employee
Employee

Hi

Some updates regarding the new format.

We will add a 'one pager' that lists the fixed from ALL takes including the filter option.
The issue reported by Gunther (link to txt version) is fixed.

We will post an update once all Jumbo HFs contain this one-pager

Tnx

MatanYanay
Employee
Employee

Hi All 

just a quick update ( we also adjust the post it self ) based on your feedback we adjust the Jumbo documentation format and added the “one pager”

  • We have added the “List of All Resolved Issues and New Features” page to both Jumbo and SmartConsole documents for all versions:
    MatanYanay_0-1653369429714.jpeg

     


    It contains all fixes from all previously released Takes/Builds and allows to use the Ctrl+F search together with the embedded search filter for the entire table:
    MatanYanay_1-1653369429859.jpeg

     



  • You can download the list of all resolved issues as CSV file:
    MatanYanay_2-1653369429751.jpeg

     



  • “List of Takes” was moved to the top of “List of All Resolved Issues and New Features”:MatanYanay_3-1653369430021.jpeg

    Thank you

    Release Operation Group and Knowledge Management Group

Daniel_
Collaborator

One more suggestion for improvement from my site...

Can you modify HTML-Code to get the Version and jumbo inside the title-tags (like "R81.10 jumbo")? Then I could open it faster if I type it in the URL bar in chrome. Otherwise titles of all versions are just the topic (like "Introduction").

Thanks!

0 Kudos
Stella_Sh
Employee
Employee

Do you mean we should add the <title> flag? Please provide a step-by-step description, because your suggestion is not clear.

 

0 Kudos
Daniel_
Collaborator

In the old SK
https://supportcenter.checkpoint.com/supportcenter/portal?eventSubmit_doGoviewsolutiondetails=&solut...
the HTML title code is
<title>Jumbo Hotfix Accumulator for R81.10 (R81_10_jumbo_hf)</title>

In
https://sc1.checkpoint.com/documents/Jumbo_HFA/R81.10/R81.10/Introduction.htm?tocpath=_____1
it's just
<title>Introduction</title>

So in a Tab in your browser you can not see the Version (if you have opened different versions) or can use your browser history to open the URL by typing "jumbo" in URL-bar.

2022-05-24 15_57_53-Neuer Tab.png

 

Stella_Sh
Employee
Employee

The current format has a different structure, but search for "jumbo" from the address bar still works.

We will update our code to adjust this better

 

 

0 Kudos