Skip to content

Editing Old Rule Pages in Archive

Jeoffrey Fischer [SSW] edited this page Aug 13, 2024 · 26 revisions

Context

When the old SSW Website V1 was migrated to the new SSW Website, many of the old Rules pages were archived as static HTML at www.ssw.com.au/archive. Some of this content might still be relevant.
To keep track of which Rules are migrated from www.ssw.com.au/archive to www.ssw.com.au/rules, we should add a note with an emoji in the relevant Rule's HTML file.

Available Emojis

The emojis that can be used are the following:

  • Migrated to {{ LINK TO RULE }}
  • 🗒️ Archived to {{ LINK TO RULE }}
  • Pending Review from {{ REVIEWER NAME }}
  • Not Migrated because {{ REASON }}

Steps to Edit an Old Static HTML Rule

  1. Access the Repository:
    Go to the repository where the archived rules are stored: SSW.Website-v1-Progress
  2. Locate the Rule:
    Navigate to the specific Rule that needs editing.
    💡 Tip: Use the page URL for easier navigation.
    For example, if the Rule is at www.ssw.com.au/archive/standards/rules/rules-to-better-sql-reporting-services.html, navigate to SSW.Website-v1-Progress | archive | standards | rules | rules-to-better-sql-reporting-services.html.
  3. Edit the File:
    Click the "✏️ Edit this file" button in the top-right corner.
    Make your changes, including adding emojis ✅🗒️⌛❌ and relevant details.
  4. Commit Changes:
    Click "Commit changes" in the top-right corner.
    Write a commit message detailing your changes:
  • For small changes, commit directly to the main branch.
  • For larger changes, create a new branch, open a pull request, and have another developer review it.
  1. Merge Changes:
    Click "Squash and Merge."

You should see your changes in a couple minutes.

Screenshot

Below is an example of updated rules with emojis to help with tracking:

image Figure: Old rules stored as HTML under /archive with an added line to help tracking