ardalis / deviq-gatsby Goto Github PK

View Code? Open in Web Editor NEW

45.0 6.0 31.0 114.59 MB

License: MIT License

JavaScript 97.15% MDX 1.84% Dockerfile 1.01%

gatsby gatsbyjs hacktoberfest

deviq-gatsby's Introduction

DevIQ Gatsby

A gatsby static site for DevIQ.com.

Dev Containers

If you don't have Node, NPM, or Gatsby installed locally, don't panic! We have Development Containers configured in the .devcontainer folder. These allow you to run your apps in containers locally. You can also use these with Visual Studio Code. You do need to have Docker running in order to use the container.

The Dockerfile starts with a Node image that we need for this repo. It also installs the Gatsby CLI tooling.

Local Dependencies

If you do want to run this locally and not within a dev container, you will want to have the following installed:

Gatsby CLI
Node v.20.10.0 - You can also use nvm and have it download 20.10.0.

Build Locally

To build locally, install the gatsby command line tools:

npm install -g gatsby-cli@latest-v4

Next, run these commands:

npm install --legacy-peer-deps

gatsby build
gatsby serve

You may also need to run this to clean up local cached files:

gatsby clean

When you're doing active development, run:

gatsby develop

This will build the site and watch the folder for changes, automatically updating as changes are detected.

Adding Frontmatter to a File

This project has a .vscode folder checked in. There is a snippet within that folder to make it easier to insert the frontmatter into a new page.

Within VS Code:

Bring up the Command Palette.
Search for Snippets: Insert Snippet
In Workspace Snippets, select the snippet named deviq-template.

Exporting Mermaid Diagrams to SVG

You can use mermaid-cli to convert Mermaid diagrams to SVG. This is how we create Mermaid graphs with links.

SVG is XML under the covers and can be styled and edited.

deviq-gatsby's People

Contributors

Stargazers

Watchers

deviq-gatsby's Issues

Add a Page for Tactical Design in DDD

Domain Events

Design Pattern
DDD Pattern
Reference Pre/Post persistence events in WeeklyDevTips (YouTube)

Add announcement div at top of page

Initial version can be static for site.

Eventually I'd like to be able to change it per section (design patterns, ddd, etc.)

Something like this:

Site Stats

Can we get stats on things like:

How many pages?
Maybe how many pages by category?
Are we tracking other metrics?

Add Process Bloat antipattern

Link it to my blog post from today on ardalis.com

Add Magnifying Glass Icon to Search

Just put the icon next to it so it's easier to see.

Add Image and more Content to CI

https://deviq.com/practices/continuous-integration

Update Google Analytics for new gtags

I see this site uses gatsby-plugin-google-analytics. We might want to look into migrating to gtag based on the deprecation notice here: https://www.gatsbyjs.com/plugins/gatsby-plugin-google-analytics/

Backends for Frontends (BFF) Pattern

I've been running into this lately in my feeds and didn't see it here. Adding this to get it on our radar.

Add Factory Method pattern

We didn't have this somehow. We will shortly.

Add a promo box on the right

Add a promotion box on the right that can be used to link to Pluralsight, Amazon recommended books, NimblePros, or whatever.

Add Terms Page

I noticed the other sections have their own dedicated pages which you can navigate to subtopics from. Terms is missing this page but has topics beneath it so it'd be worth adding a page for listing those individual items on.

Add Object Mother pattern

See: https://martinfowler.com/bliki/ObjectMother.html

I've always thought this was a pretty stupid name but others will search for it so we should include it. It's just a factory or builder, and folks should call it that, IMO...

Add Shared Kernel to the DDD concepts

Working on a DDD email course and realized we don't have a page for this yet. We should add this!

Add Constantine's Law

"A structure is stable if cohesion is high, and coupling is low." - Larry Constantine

This is quoted in the book Monolith to Microservices: Evolutionary Patterns to Transform Your Monolith by Sam Newman (O'Reilly)

The initial quote comes from Larry Constantine's Structured Design (1963).

Rule of Distributed Systems

https://martinfowler.com/bliki/FirstLaw.html
https://bravenewgeek.com/service-disoriented-architecture/

Add Links and Fix Rendering

https://deviq.com/design-patterns/domain-events-pattern

Right nav stuff is rendering below for me in chrome/pc

Also it needs links in the Design Patterns nav menu and on the DDD Overview page https://deviq.com/domain-driven-design/ddd-overview

Add Rule Engine Pattern

Link to Pluralsight course.

Include this info:
Q: Is it violating Open Closed principle if the rule returns a value that includes extra information (whether or not rules are short circuited) (I've got a combination of First match and aggregation)

A: No that’s probably fine. If your engine code gets too complex maybe you create types representing the different kinds of rules and/or their results that let you Replace Conditional with Polymorphism.

Q: In the case of ordered rules, is it wrong to pass (and change) contextual information from one rule to the next?

A: Not wrong but makes me think Chain of Responsibility might be a good fit.

(and make sure Chain of Responsibility is in our pattern list as well) #290

Add searchability

Add ability to search the content - can use Google with site:DevIQ.com

Add a page for the practice of Behavior Driven Development

To be linked in the "Thank You" email for the October 2023 SpecFlow webinar
What is BDD?
BDD vs TDD?
Include nods to SpecFlow and Gherkin

Update Explicit Dependencies Principle

Change "References" to "See Also"
Link back to Better Cooking and code with the Explicit Dependencies Principle
Add in the spaghetti bolognese recipe reference!

Replace 'other' with 'terms'

Replace folder path and nav for Other section at bottom with Terms.
Update the production redirect file to redirect from the /other/foo links to the new /terms/foo links.
Move Singleton to Design Patterns and add redirect(s) and fix any direct links to it.

Add a Page for Domain for the DDD section

Anderson's Law

Cited here: https://youtu.be/FyCYva9DhsI?si=sq6IylyM-db9SmNw&t=1043

Not seeing it anywhere online, though...

Mediator Design Pattern

Add the pattern
Reference from Domain Events
Reference from any other place where we mention MediatR.

Question on Patterns organization

@ardalis With the growth in pattern ideas, do all of these get put in design patterns? Do we break them up to something like Design Patterns, Data Patterns, and Testing Patterns?

For example, I want to include some of the data patterns that I am used to working with, but they are specifically related towards data.

#315 mentions a pattern that is specifically to testing.

As we start to grow, it may make sense to break these out more.

Add new section, Laws

Add a new section for Laws. Start with a placeholder Law:

Murphy's Law

It should appear in the nav below Terms.

Add Arrange-Act-Assert Pattern Overview

I noticed this common pattern was missing so it may be worth adding at some point

Laws: Rules of Simple Design

Not exactly a "law" but still good to include.

Reference:
https://martinfowler.com/bliki/BeckDesignRules.html

Event Storming

Add Event Storming under Practices
Include a FeaturedImage
Search for the term on DevIQ and link back to this page once it exists.

CQRS

Add a principle describing CQRS.

Add Tools Page

I noticed the other sections have their own dedicated pages which you can navigate to subtopics from. Tools is missing this page but has topics beneath it so it'd be worth adding a page for listing those individual items on.

Add Proper Header image and Sidebar coloring

Goal

banner.png from /static should take the place of the logo at the top of the sidebar. Currently, this logo comes from a Logo.js file in the node modules under path: node_modules/@rocketseat/gatsby-theme-docs/src/components/Logo.js This is an svg that defines a "Rocketseat" logo.

Additionally (and the solution to this is probably related to the solution to the above, so I'm including them together), the sidebar link to the current page should be highlighted in #1E73BE (blue), rather than the current purple (#8257E6, I think. Also defined in the node modules).

Notes

For some reason, this template (gatsby-starter-rocket-docs) seems to rely on the node modules for most styling. And the node modules can't really be edited and have those changes persist. So the question, really, is how to override the stylings in the node modules via changes to the main code.

Add Page Object pattern

This is the pattern that is used commonly with Selenium when testing on the front-end.

Add featuredImage support in frontmatter/headings

See my blog or the NimblePros blog. I'd like to be able to show a featured image at the top of the page, and also use it in social media links, for each article. I don't want to have to manually include the image in the article's markdown.

Add Saga Pattern

Messaging is something we deal with often.

Saw Cameron's tweet and realized we don't have Saga pattern here yet.

Chain of Responsibility Pattern

Mention use with

ASP.NET Core Middleware
MediatR and pipeline behaviors

and its importance for pulling out cross-cutting concerns (and following Separation of Concerns, SRP)

Add Outbox Pattern

Link to my forthcoming article on sending emails with Outbox.

Also link my ardalis.com article to the deviq outbox pattern description.

Template Method Pattern

Saw @ardalis mention this in devBetter.

Create a page here for the Template Method Pattern
Link to the Pluralsight course that is currently linked on the Design Patterns overview.
Add link to our page in the navigation.
Update the Design Patterns overview to point to our page.

Add a Page for Strategic Design in DDD

Add Reactor Pattern

Sources

Wikipedia: Reactor Pattern
Initially saw this referenced on Why Brighter?

REPR is missing from the sidebar

Add support for C# code highlighting

Repo currently uses Prism-React-Renderer for code highlighting, which does not natively support C#. I tried commenting out all references to prism-react-renderer and to react-live (which it is a part of) in the json files, and installing prism.js (which does support C#), but this did not change the behavior

Open menu section for selected page

Whenever you are on a page, make sure the menu on the left is expanded for the current section.

Implement a collapsing menu since it's getting rather long

The left nav menu should support expanding and collapsing each section in the browser.

Chain of Responsibility Pattern

Saw @ardalis mention this in devBetter.

Create a page here for the Chain of Responsibility Pattern
Add link to our page in the navigation.
Update the Design Patterns overview to point to our page.

The guard statements can be more explicit

Assuming the code depicted is c#, this guard clause

 if (user == null)
    {
        throw new ArgumentNullException(nameof(user));
    }

can be written as

_ = user ?? throw new ArgumentNullException(nameof(user));

... and avoid hiding the behavior of the guard in another function, like this does...

 Guard.AgainstNull(user, nameof(user));

Resharper's live templates or VS snippets make creating these statements an easy experience.

For strings an extension method that returns null if the string is null or whitespace means the discard based pattern can be used for strings.
The same can be done for empty collections