Code Monkey home page Code Monkey logo

ssw.rules.content's Introduction

The SSW Rules content ๐Ÿ“œ

Welcome to SSW.Rules.Content (The Data in markdown). Thank you for contributing best practices into SSW Rules!

SSW.Rules YouTube Channel

Pull Requests, Builds and Releases

Builds are done in AzureDevOps, after a rule is edited a Pull Request is created you must wait for a Rule Master to accept it. There are about 15 of them and they all work at SSW.

Structure

  • Rules live in the rules folder
  • Categories live in the categories folder
  • Each rule has a folder containing rule.md and images/assets
  • Rules are organised into categories
  • A rule can belong to multiple categories
  • Category pages link to rules via frontmatter data

The SSW Rules engine ๐Ÿš—

This is built into a static site by the code at SSW Rules.

ssw.rules.content's People

Contributors

andreaslengkeek avatar ashanil avatar bradystroud avatar brendanrichards avatar brittanylawrencessw avatar brookjeynes avatar camillars avatar chrisschultzssw avatar christianmorfordwaitessw avatar fenix2222 avatar gordonbeeming avatar hveraus avatar jackdevau avatar jaydenalchin avatar jontygardner avatar kikibianc avatar leahy268 avatar leehawkinsssw avatar matt-goldman-ssw avatar pennywalker avatar piers-sinclair avatar sethdaily avatar sswrebeccaliu avatar tiagov8 avatar tkapa avatar tombui99 avatar uly1 avatar ulyssesmaclaren avatar wicksipedia avatar zl24622 avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

ssw.rules.content's Issues

Bad Search Experience...First result is an ancient relic

Bad Search Experience... First result is an ancient relic

Describe the bug When I use the rules search feature, the first result is some kind of legacy rule that looks old and bad

To Reproduce Steps to reproduce the behavior:

  1. From www.ssw.com.au/rules/, search for "connection strings"
    image
  2. This takes you here: https://www.google.com.au/search?q=site:ssw.com.au%20connection%20strings
    Click on the first result:
    image
  3. Hmm, this is weird: https://www.ssw.com.au/ssw/Standards/Rules/RulesToBetterConnectionStrings.aspx
    Not only is it super old but it also has a SQL Server error on it...not a good look!
    image

Expected behavior The first result should be a connection string rule and the legacy rule should not be visible

FYI @adamcogan @bradystroud

Suggestion - Make all headings anchor links

Some rules are long, and you just want to draw attention to a specific part of it.

e.g. I want to recommend that someone adds more detail to a done email...I would like to point them to tip #2 on this page: https://www.ssw.com.au/rules/dones-do-you-reply-done-and-delete-the-original-email

Right now I need to say, go read this rule and pay special attention to the second tip...which is kind of annoying.

It would be cool if I could give them a link directly to tip #2 e.g. https://www.ssw.com.au/rules/dones-do-you-reply-done-and-delete-the-original-email#tip-2-provide-details-in-your-done

Also - when I hover over a heading I'd like to see a link icon that indicates clicking on it will copy the anchor link...to see what I mean go to any Microsoft docs page e.g. https://docs.microsoft.com/en-us/sharepoint/introduction and hover on a heading.

Here is a rule about it too ๐Ÿ˜ https://www.ssw.com.au/rules/do-you-know-how-to-use-named-anchor-links

Rule is redirecting to an old Consulting page

Team,

This rule https://www.ssw.com.au/rules/do-you-know-why-you-should-chinafy-your-app is redirecting to https://www.ssw.com.au/ssw/Consulting/Chinafy-b.aspx and giving a CodeAuditor error:

Screen Shot 2021-03-11 at 3 06 21 PM

I am not sure WHY we have this redirect and I see no reason for it right now

  1. Can we find out how this redirect was set? Maybe there is some kind of comment explaining the reason
  2. Do we have others? If yes, what are they?

@UlyssesMaclaren

  1. Can we remove that rule/redirect?

--

PS. This is the final page https://www.ssw.com.au/ssw/Consulting/Chinafy-App.aspx

Content - Authentication rule needs updating

bug_report

Describe the bug
This rule: https://www.ssw.com.au/rules/choose-the-best-method-of-authentication-for-your-situation
Has a couple of typos. But more importantly the logic of how to select the right authentication solution is flawed, and doesn't focus on the main differences between these options.

To Reproduce

  1. View rule at this address: https://www.ssw.com.au/rules/choose-the-best-method-of-authentication-for-your-situation

Expected behavior
The rule should clearly explain the differences between these options so that you can make a selection based on their relative strengths and weaknesses, while identifying the best fit for your needs.

AB#59870

โœจContent - Add coding standards category and rules

Hi Myself,

Separating #716 and moving the rules part of the PBI over here.

  1. Please write the following rules and create the new category below
  • Add a new category "Rules to better VS Code"
    • Add a rule "Do you have recommended extensions in vscode?"
    • Add a rule "Do you have enforced settings in vscode?"

Uncategorized and archived rules not showing on "Archived" page

Hi team,

I noticed that https://www.ssw.com.au/rules/archived only shows the rules separated by category.

a. When I archive a rule I normally remove it from the category list to make things cleaner.

b. Plus I also have moved rules from ASPX that are already archived, so there is no point in also adding them to a category (e.g. https://www.ssw.com.au/rules/avoid-creating-multiple-team-projects-for-the-same-project)

In both cases, I am assuming the rules DON'T show in https://www.ssw.com.au/rules/archived

  1. Please add an "Uncategorized" section to https://www.ssw.com.au/rules/archived

Finetuning - Replace the 404 page with a dynamically generated rule from GPT-3

I have trained a GPT-3 model with the dataset of all SSW Rules.
URL is the input and markdown including frontmatter is output.

As a fun/cool feature, let's never show a 404 page again, and instead send the URL to GPT-3 to create the page and dynamically display it.

Make it obvious that this is not real content
Eg. This rule does not exist, but we have proposed content
[see this proposed rule - powered by AI]

MicrosoftTeams-image (3)
Figure: Example generated rule

GitHub issue syncing should comment as a service account

bug_report

Describe the bug
Currently Christian is setup as the commenting user when syncing GitHub issues via GitHub actions.

To Reproduce

  1. Create a new GitHub issue.
  2. Find and open it in Azure DevOps
  3. View the comments section and it will show Christian commenting instead of a service account.
    image

Expected behavior
A service account should be the commenting user which can be done by generating a PAT for the service account.

Screenshots If applicable, add screenshots to help explain your problem.

Additional context Add any other context about the problem here.

Remove duplicate rules

(Checked by Jack)
Cc: @JackDevAU @christianmorfordwaitessw @pierssinclairssw

Hi @tiagov8,

In relation to your comment on Issue #300 for SSW.Rules we have found multiple rules that have the same problem and would like to address them at the same time.

This issue seems to be because the rule has been duplicated, rewritten and redirected to the duplicated rule.

image
Figure: Showing the same rule duplicated and put into different folders

  • Go through the identified list of duplicated rules in the /rules folder below
  • Investigate who made these changes and why.
  • Identify any further rules that are duplicated in the repository
  • Compare the duplicate rules and decide which version should stay.

NOTE: We suspect that any folder ending in 1 is the more recent and true version of the rule as these duplicates redirect from the old uri.

Identified Rule Duplicates:

  • do-you-backup-your-databases
  • do-you-disable-connections
  • do-you-do-a-quick-test-after-the-upgrade-finishes
  • do-you-get-a-developer-to-test-the-migration
  • do-you-have-a-mobile-friendly-website (No original rule)
  • do-you-have-a-rollback-plan
  • do-you-know-to-upgrade-your-third-party-tools
  • do-you-know-your-migration-choices
  • do-you-plan-your-additional-steps
  • do-you-run-dog-food-stats-after
  • do-you-run-your-dog-food-stats-before
  • do-you-schedule-a-followup-meeting-after-a-spec-review (No original rule)
  • do-you-turn-off-database-mirroring-before-upgrading-your-tfs-databases
  • does-your-user-account-have-sql-server-system-administrator-privileges-in-sql-server
  • dates-do-you-keep-date-formats-consistent-across-your-application

Naming Azure resources rule feedback

Cc: @adamcogan @pierssinclairssw @matt-goldman @wicksipedia @brydeno

Hi @lukecookssw,

https://www.ssw.com.au/rules/azure-naming-resources

This naming convention wont work in some scenarios. There is a plan for the exceptions section but it doesn't actually explain how to plan for exceptions.

The rule should suggest how to handle exceptions, or not suggest a naming convention at all.
Not suggesting a naming convention would make this rule easier to maintain.

  1. If you agree, update the rule to not suggest a naming convention

Images - Missing alt text

cc: @JackLeerson @adamcogan
Hi @tiagov8,

CodeAuditor is finding some errors in the HTML where images do not have alt text. https://htmlhint.com/docs/user-guide/rules/alt-require

You can see all the rules with images missing alt text here.

2021-03-22_14-38-02
Figure: Image missing alt text

The alt text can be easily added in the Markdown using this syntax:

![Figure: Good figure](https://images.unsplash.com/photo-1491472253230-a044054ca35f)
  1. Please go through all the rules and add alt text (figure statements)

Thanks,

-Brady

AB#60567

Suggestion - Monetise Rules via NFT

NFTs are the latest craze.
Let's monetise rules by creating an NFT for each rule and selling them.
Similar to tweet NFTs.
We can also display the avatar of the current rule owner on the rule...and integrate with the SSW Rewards app to display your owned rules in your rules wallet.
This will also encourage end user interaction as people will want to keep rules they own up to date.

Missing Uly's image on Acknowledgements

Hey @bradystroud

I noticed this new rule doesn't show Uly's photo: https://www.ssw.com.au/rules/understand-the-power-of-empathy

Screen Shot 2021-04-15 at 5 28 03 PM

I assume it is because Uly's profile has a redirect from https://www.ssw.com.au/people/ulysses-maclarem to https://www.ssw.com.au/people/uly and I used the second link in the author section:

authors: 
- title: Ulysses MacLaren
  url: https://ssw.com.au/people/uly

Of course, I could fix that, but wondering if there is a way to make that URL show the photo too, which would be ideal...

  1. Please action ;)

Cheers,
Tiago

Migration issues - links on captions + missing image?

cc: @adamcogan @christianmorfordwaitessw @JeanThirion
(copy of email from @tiagov8)

Hey Brady,

Came across this rule which has a bad formatting: https://www.ssw.com.au/rules/post-production-do-you-add-content-to-youtube-to-feed-traffic-to-your-other-sites

I believe the migration went wrong here because it had links in their captionsโ€ฆ so here are a few things to be fixed:

  1. Do we have a way to add links to captions?
  • If not, can we find others that have the same problem?
  1. Can you investigate what happened with this one and try to fix
  • There are 3 figure captions, but only 2 images โ€“ I assume 1 went missing!
  1. Add Acknowledgements

--

image
Figure: Bad formatting + potential missing image

Cheers,
Tiago

Bug - PR failing ONLY on category change

I've got errors on PRs that are related to rule category changes:

https://github.com/SSWConsulting/SSW.Rules.Content/actions/runs/612029603 and https://github.com/SSWConsulting/SSW.Rules.Content/actions/runs/612021324

as per @bradystroud :

[Monday 2:31 PM] Brady Stroud www.ssw.com.au
Hey Tiago, it looks like the script that generate the history file fails when you move rules to another category
  1. Please investigate and fix

Note: Related to Uly's #121 except his PRs are simple content changes... mine are only if I update categories

AB#60220

BUG - Code blocks are not syntax highlighting

Cc: @bradystroud @tiagov8

Hi team,

Code blocks should be highlighting as in Figure 1, but are white like Figure 2.

This is because they are missing the language tag in the markdown as shown in Figure 3. The white code block markdown is shown in Figure 4.

  1. Add the relevant language tag to all code blocks in rules.

image
Figure 1: Code block on https://www.ssw.com.au/rules/rule

image
Figure 2: Code block on https://www.ssw.com.au/rules/do-you-use-windows-integrated-authentication-connection-string-in-web-config

image
Figure 3: Javascript language tag present

image
Figure 4: Language tag not present

AB#60212

Bug - Content showing blank on netlify mode

Cc: @tiagov8 @adamcogan @UlyssesMaclaren

(Checked by Tiago)

Hi @bradystroud

RE: SSW.Rules | Tabs - Do you add the right tabs when creating a new Teams conversation?

I am trying to update the acknowledgments on this rule - https://www.ssw.com.au/rules/teams-add-the-right-tabs

When I hit edit via netlify I don't see any content at all. I tested other netlify and it was all working fine. I know I could do this via GitHub, but as per my conversation with Tiago since there is a bug we decided to log this as an issue.

  1. Please investigate and fix
  2. Tell me to update acknowledgments once the bug is fixed

image
Figure: No content showing for me to edit

๐Ÿง“ Old Rules - Code Quality rules are out of date

โœจRule Content Linting

Cc: @bradystroud @adamcogan @tiagov8

Hi Team,

Pain

Recently there have been some rules that on merge have caused builds to fail. These are often due to malformed Markdown or frontmatter that have small issues like an incorrect amount of spaces. These are things that anyone could miss and as such should be part of automated checks.

Solution

To make rules as non-blocking as possible, I recommend adding 1-2 new actions that run per PR to validate the Markdown and its Frontmatter (yaml).

From a quick search, here are a few already made actions that help solve this issue:

Tasks

  • Investigate the best actions to use lint/validate Markdown
  • Investigate the best actions to use lint/validate Frontmatter
  • Implement the new actions

Thanks

External images not working with lightbox, and not suitable for long term reliability.

Cc: @adamcogan @tombui99 @pierssinclairssw @theixdev @zacharykeeping @tiagov8

Hi All,

It is of concern that external images (even SSW.com.au) are too volatile and it is better to store images within the git folder itself.

Additionally, the Gatsby module for creating lightboxes on image click does not function for images that are not in the git folder.

  • Create a rule to find images not stored in Git.
  • Fix images so that they are stored in Git.

BUG - Images size on "add or remove someone from conversations" rule

Cc: < @pierssinclairssw @calumjs @bradystroud >

Hi team,

This rule https://www.ssw.com.au/rules/do-you-know-how-to-add-or-remove-someone-from-the-conversation images are going over the limits of the content area (desktop screen)

Screen Shot 2021-05-10 at 10 45 03 AM

  1. Please investigate and fix
  2. I believe this wasn't happening some weeks ago... any recent changes to the CSS (behaviour of the images)?

Tip: This piece of CSS should be present for any screen size, not only under 768px:
Screen Shot 2021-05-10 at 10 45 43 AM

๐Ÿ› Bug on rule - List under list not rendering correctly

Cc: @camillars @adamcogan

Hi @bradystroud

Unordered lists under numbered lists in this rule https://www.ssw.com.au/rules/why-should-a-business-use-tiktok are not working... what should be bullet points are showing new numbers for the parent list (see from 2-6 and 8-9)

Screen Shot 2022-05-12 at 3 49 53 PM

Figure: The items should be bullet points

The Markdown looks alright, so as the previews from GitHub and Netlify...

Screen Shot 2022-05-12 at 3 51 51 PM

Figure: Markdown looking fine

Note: I even tried redoing the Markdown here: #3152

  1. Please investigate and fix
  2. Add details to wiki documentation if necessary

Content update on https://www.ssw.com.au/rules/the-best-sample-applications

Cc: @adamcogan, @UlyssesMaclaren, @brydeno

On https://www.ssw.com.au/rules/the-best-sample-applications

  1. Update references of SQL Server 2017 to the latest (2019)
  2. Split Angular section into 2 UI sections:
    a. UI โ€“ Angular
    b. UI โ€“ React
  3. Add a React example (https://reactjs.org/tutorial/tutorial.html)
  4. Add a Blazor example (https://github.com/jsakamoto/awesome-blazor-browser)
  5. Add reference to Jason Taylorโ€™s Clean Architecture Framework (https://github.com/jasontaylordev/CleanArchitecture)

UI - Image Rendering Inconsistent with v1

bug_report

Describe the bug
The way that images are displayed in v2 is inconsistent with the way they are displayed in v1, leading to some unexpected behavior.

To Reproduce

  1. Go to https://rules.ssw.com.au/choose-the-best-method-of-authentication-for-your-situation
  2. In another tab, go to https://www.ssw.com.au/rules/choose-the-best-method-of-authentication-for-your-situation
  3. Observer the difference between how the introductory image is rendered

Expected behavior
Images should be rendered the same dimensions (and possibly with the same decoration)

Screenshots
image
Figure: Comparison of image displayed on Rules v1 and same image in same rule in v2

Desktop (please complete the following information):

  • OS: Windows 10
  • Browser: Edge
  • Version: 89.0.774.23

AB#59872

Adding a slash to the end of a previously named rule causes redirect to stop working

@bradystroud @JackLeerson

bug_report

Describe the bug
Adding a slash to the end of a previously named rule causes redirect to stop working

To Reproduce Steps to reproduce the behavior: 1. Go to '...' 2. Click on '....' 3. Scroll down to '....' 4. See error

  1. Navigate to https://www.ssw.com.au/rules/do-you-use-the-best-static-site-generator/
  2. You see a 404 error.

Expected behavior
You should see the updated rule and the new url for it.

Screenshots If applicable, add screenshots to help explain your problem.

MicrosoftTeams-image (25)
https://user-images.githubusercontent.com/79821522/112391570-39b31280-8d4c-11eb-9a62-d4dde1c061b2.mov

Desktop (please complete the following information):

  • OS: Windows 10
  • Browser Chrome and Edge

Additional context Add any other context about the problem here.

๐Ÿ› Existing images showing as broken on CodeAuditor and Netlify

Cc: @tombui99 @adamcogan

Hi @bradystroud ,

https://ssw.com.au/rules/control-choice-do-you-know-when-to-use-checkboxes/

The last 2 images in this rule were caught as broken by CodeAuditor (see report)

โœ… The images are showing up in the public view

โœ… They are also included in the folder: https://github.com/SSWConsulting/SSW.Rules.Content/tree/main/rules/control-choice-do-you-know-when-to-use-checkboxes

โŒ But I noticed they are broken on Netlify view:
Screenshot 2023-01-18 at 1 09 36 PM

โš ๏ธ I also noticed they are GIFs instead of PNG/JPG. I assume that shouldn't be a problem...

  1. Please investigate and let us know what caused the problem and how to avoid/fix

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.