README.html #21

  • //
  • guest/
  • perforce_software/
  • sdp/
  • dev/
  • README.html
  • Commits
# Change User Description Committed
#21 30379 C. Thomas Tyler Updated README.md for 2024.1 release.

Removed the generated README.html file due to issues with rendered HTML format.
The automated rendering via Helix Swarm is rather nice.
#20 30000 C. Thomas Tyler Refined Release Notes and top-level README.md file in preparation
for coming 2023.2 release.

Adjusted Makefile in doc directory to also generate top-level
README.html from top-level README.md file so that the HTML file is
reliably updated in the SDP release process.

Updated :revnumber: and :revdate: docs in AsciiDoc files to
indicate that the are still current.

Avoiding regen of ReleaseNotes.pdf binary file since that will
need at least one more update before shipping SDP 2023.2.
#19 29932 C. Thomas Tyler Merge down @29916 from main:

Removed mention of Helix Installer while we resolve issues around inexperienced users managing to zap their existing repository.

#review-29933
#18 29915 Robert Cowham Remove reference to Helix Installer for now.
#17 28852 C. Thomas Tyler Release notes corrections and tweaks to SDP home page
related to the major version change..
#16 28385 C. Thomas Tyler Updated README for coming r21.2 release.

Enhanced product description to emphazise key SDP benefits, better
describing the value of the Offline DB.

#review-28386
#15 27482 C. Thomas Tyler README.md updates:
* Added Documentation References section, with less clutter and easier links to PDF/HTML versions of key docs, including the upgrade guide.
* Enhanced "Sophistication Simplified" section.
* Simplified Support status text.
* General grammer corrections.
* Removed a broken link.
* Simpflified Contribing sections.
* Enhanced formatting/TOC levels, moved several sections under new "Features and Benefits" section.

#review-27483
#14 27444 C. Thomas Tyler Fixed issue with broken doc links.
#13 27015 C. Thomas Tyler Replaced notes in README.md re: upgrading SDP with ref to new SDP Upgrade Guide doc.

The doc URL references not-yet-existing SDP r20.1 branch.
#12 26652 Robert Cowham This is Tom's change:

Introduced new 'Unsupported' directory to clarify that some files
in the SDP are not officially supported. These files are samples for
illustration, to provide examples, or are deprecated but not yet
ready for removal from the package.

The Maintenance and many SDP triggers have been moved under here,
along with other SDP scripts and triggers.

Added comments to p4_vars indicating that it should not be edited
directly. Added reference to an optional site_global_vars file that,
if it exists, will be sourced to provide global user settings
without needing to edit p4_vars.

As an exception to the refactoring, the totalusers.py Maintenance
script will be moved to indicate that it is supported.

Removed settings to support long-sunset P4Web from supported structure.

Structure under new .../Unsupported folder is:
   Samples/bin             Sample scripts.
   Samples/triggers        Sample trigger scripts.
   Samples/triggers/tests  Sample trigger script tests.
   Samples/broker          Sample broker filter scripts.
   Deprecated/triggers     Deprecated triggers.

To Do in a subsequent change: Make corresponding doc changes.
#11 26388 C. Thomas Tyler Regenerated README.html from README.md using
https://markdowntohtml.com/

The generated README.html is now much smaller than the previous
one, which was created using the "Export as HTML" function of the
MWeb Markdown editor utility.
#10 25591 C. Thomas Tyler Clarified that Maintenance folder scripts are samples and are
NOT officially supported.

Updated references to HMS now that it has been split back out
into a separate product.
#9 25155 Robert Cowham Refer to test/README.md
#8 25043 C. Thomas Tyler Prepared patch SDP/MultiArch/2018.1/23583.p2

Changes:
* In README, moved 'Supported Open Source Software' section
to the top of the page, to make Support position more visible.
* Copyright updated to 2019.
* Cleanup of excess script recreate_db_sync_replica.sh
* Re-removal of previously deleted script recreate_db_checkpoint.sh,
and corresponding removal from test suite.
* This patch tarball will also contain some Docker test suite updates
already staged in main.

By-passing review to trigger an automated test.
#7 24511 C. Thomas Tyler Fixed an obvious doc typo in README files.
 Bypassing code
review.
#6 23353 C. Thomas Tyler Fixed typo/grammatical error.
#5 23315 C. Thomas Tyler Overhauled SDP README page to better convey its value, and
much more strongly promote the SDP.

This also documents the the nature of offical Perforce Support
for the SDP, and the limitations of that Support to core SDP
functionality.
#4 11535 Russell C. Jackson (Rusty) Updated dev from main.
#3 11463 Russell C. Jackson (Rusty) Updated dev to prepare for Summit agreed changes.
#2 11038 Robert Cowham Catchup from Main
#1 10666 C. Thomas Tyler Merge down from main.
 No actual merging was needed (just
'resolve -as').
//guest/perforce_software/sdp/main/README.html
#1 10644 C. Thomas Tyler Added README.html generated from README.md.