sswconsulting / ssw.rules.content Goto Github PK
View Code? Open in Web Editor NEWSecret ingredients to quality software
Secret ingredients to quality software
Cc: @adamcogan @pierssinclairssw @christianmorfordwaitessw
Hi @JackDevAU,
Upon trying to log into the Netlify CMS, I was presented with an HTTP 500 Error.
Figure: Showing HTTP 500 Error when trying to log into Netlify CMS
Hi team,
Some images in this rule https://www.ssw.com.au/rules/do-you-know-when-to-branch-in-git are not showing.
I can see them in the old SharePoint: https://rules.ssw.com.au/do-you-know-when-to-branch-in-git
Cc: @adamcogan
Hi @tiagov8 ,
https://www.ssw.com.au/rules/email-send-a-v2
The v2 rule does not have Adam's video in it. I recall seeing it recently and I think it could be a useful addition.
Thanks
Hi @wicksipedia ,
This rule is over 9 years old, small and the prescription it's making is odd.
https://ssw.com.au/rules/do-you-know-when-to-use-typescript-vs-javascript-and-coffeescript/
CoffeeScript seems to be mostly dead and TypeScript has such high adoption that I feel it should be more of a "Use TypeScript unless held at gunpoint" type of situation
Cc: @bradystroud @adamcogan @tiagov8
Hi Team,
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.
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:
Thanks
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
Expected behavior
Images should be rendered the same dimensions (and possibly with the same decoration)
Screenshots
Figure: Comparison of image displayed on Rules v1 and same image in same rule in v2
Desktop (please complete the following information):
(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.
Figure: Showing the same rule duplicated and put into different folders
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.
Hi team,
the image on https://www.ssw.com.au/rules/rules-to-better-scrum-using-azure-devops summary is broken:
the image on https://www.ssw.com.au/rules/rules-to-better-google-rankings is also broken:
AB#60473
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
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.
Test
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.
Figure 1: Code block on https://www.ssw.com.au/rules/rule
Figure 2: Code block on https://www.ssw.com.au/rules/do-you-use-windows-integrated-authentication-connection-string-in-web-config
Figure 3: Javascript language tag present
Cc: @UlyssesMaclaren @adamcogan
Hi @wicksipedia ,
as per email RE: SSW.Rules - TODO: Include Steps for Continuous Delivery with Azure and VisualStudio.com
Hey @bradystroud ,
Any idea what happened here? https://www.ssw.com.au/rules/scrum
And how you think we should proceed about it?
Any idea why the Markdown for email-template is not rendering in the good example here: https://www.ssw.com.au/rules/dones-do-you-use-email-for-tasks-only-not-communication ?
The syntax seems alright
Forwarding @tiagov8's issue from SSW.Rules repo. This is now a content issue.
Hi team,
another example with 2 old people missing:
https://www.ssw.com.au/rules/do-you-have-a-tfs-master
Note: It generated a 404 in CodeAuditor:
https://codeauditor.com/build/994b3edd-22fa-4bc8-5f3b-52caba7bac52?displayMode=2
Hi team,
https://www.ssw.com.au/rules/set-up-azure-alert-emails-on-teams-channel
I created this rule a while ago, but only today notice that "last updated by" and the dates not showing
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:
Expected behavior The first result should be a connection string rule and the legacy rule should not be visible
Hey @bradystroud
This is the PR I archived it: #4317
And this was an attempt to fix it by reducing reason: #4360
Cheers,
Describe the bug
Currently Christian is setup as the commenting user when syncing GitHub issues via GitHub actions.
To Reproduce
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.
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)
Figure: The items should be bullet points
The Markdown looks alright, so as the previews from GitHub and Netlify...
Figure: Markdown looking fine
Note: I even tried redoing the Markdown here: #3152
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:
Cc: @UlyssesMaclaren @adamcogan @AndreasLengkeek
Hi @matt-goldman ,
https://www.ssw.com.au/rules/how-to-get-mobile-config-to-your-users
as per Do you know how to get mobile config to your users? - TODO
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:
I am not sure WHY we have this redirect and I see no reason for it right now
--
PS. This is the final page https://www.ssw.com.au/ssw/Consulting/Chinafy-App.aspx
Hey @bradystroud
I noticed this new rule doesn't show Uly's photo: https://www.ssw.com.au/rules/understand-the-power-of-empathy
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...
Cheers,
Tiago
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]
https://ssw.com.au/agreements---do-you-book-the-next-sprint-ahead-of-time
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.
https://ssw.com.au/agreements---do-you-book-the-next-sprint-ahead-of-time
I think it would be cool to have a "random rule" button that will take you to a random rule, kind of like Wikipedia https://en.wikipedia.org/wiki/Special:Random
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.
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)
Thanks,
-Brady
AB#60567
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.
CC @pierssinclairssw @adamcogan
On https://www.ssw.com.au/rules/management-do-you-use-just-in-time-speccing
Also add back into category. (When i changed the URL, it lost the rules category for this rule)
Add an image to represent the rule. Liase with Piers for this
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:
--
Figure: Bad formatting + potential missing image
Cheers,
Tiago
Cc: @UlyssesMaclaren
Hi @pierssinclairssw ,
(moving 2 TODOs on the rule below to be this issue)
On https://www.ssw.com.au/rules/do-you-know-the-common-design-principles-part-2-example:
cc: @adamcogan, @pierssinclairssw
Hi @tiagov8,
As per my conversation with Adam and Piers, I should have used a GitHub Issue to give you this task so this is a copy of the email I already sent.
Thanks,
-Brady
Hi team,
This rule is the 1st result on Google https://www.ssw.com.au/rules/do-you-send-as-per-our-conversation-emails/
and is giving a 404!
The URL was shortened to https://www.ssw.com.au/rules/as-per-our-conversation-emails and from the code the redirect was applied but it's not working:
Cheers,
Tiago
AB#60471
https://www.ssw.com.au/rules/dones-do-you-include-useful-details-in-your-done-email
Look at the related rules section.
Cc: @adamcogan @bradystroud @lukecookssw
Hi @vladislav-kir,
Most of these rules are out of date! ⌚
https://ssw.com.au/rules/rules-to-better-code-quality/
Cc: @pierssinclairssw @christianmorfordwaitessw @tiagov8
Hi @JackDevAU ,
As Tiago mentioned on my issue #2082, the rule at https://www.ssw.com.au/rules/run-your-dog-food-stats-before is missing the edit history underneath the rule name.
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
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.
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
Cc: @adamcogan, @UlyssesMaclaren, @brydeno
On https://www.ssw.com.au/rules/the-best-sample-applications
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.
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
Note: Related to Uly's #121 except his PRs are simple content changes... mine are only if I update categories
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
Expected behavior
You should see the updated rule and the new url for it.
Screenshots If applicable, add screenshots to help explain your problem.
https://user-images.githubusercontent.com/79821522/112391570-39b31280-8d4c-11eb-9a62-d4dde1c061b2.mov
Desktop (please complete the following information):
Additional context Add any other context about the problem here.
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)
Tip: This piece of CSS should be present for any screen size, not only under 768px:
The 4 external links to uservoice at the bottom of the rule https://www.ssw.com.au/rules/search-employee-skills should open in new tabs.
I think generally, all external links should open in new tabs by default.
Hi Myself,
Separating #716 and moving the rules part of the PBI over here.
A declarative, efficient, and flexible JavaScript library for building user interfaces.
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google ❤️ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.