Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation updates #424

Merged
merged 45 commits into from
Oct 17, 2024
Merged

Documentation updates #424

merged 45 commits into from
Oct 17, 2024

Conversation

werdlerk
Copy link
Member

@werdlerk werdlerk commented Oct 8, 2024

Summary of changes:

  • Added Gemfile.lock for the Jekyll static site generator

  • Updated layout/styling a bit

    • Changed "Powered by Zilverline" to the Zilverline logo.
    • Moved link to source code to GitHub icon at top right.
    • Enabled site wide search
    • Enabled copy code button for all highlighted code blocks.
    • Added sitemap.xml for better SEO
    • Created new section "Handbook". These contain pages previously from "Reference" which didn't reference an exact technical item to explain. The Reference section now contains only pages that explain technical references.
    • Moved guide for integrating Sequent with Rails to new section "Handbook"
    • Made all pages use the class wide so the pages are wider to display more content.
      On pages that have a TOC, this class is removed so the space on the right can be used for the TOC.
  • Updated home page

  • Updated all introduction pages

  • Updated Rails & Sequent page

@werdlerk werdlerk self-assigned this Oct 8, 2024
@werdlerk
Copy link
Member Author

werdlerk commented Oct 8, 2024

Question:

  • At the page Modelling the domain, an AggregateRoot is created to ensure uniqueness for Author email addresses, called Usernames. This is a Singleton. Why is this named plural? Other AggregateRoots are singular and this being a Singleton, I would expect it also being named Username instead.
  • On top of that, as it's defined for the purpose of maintaining usernames (uniqueness of email addresses), would a name like UsernameMaintainer be more adequate?

@lvonk
Copy link
Member

lvonk commented Oct 9, 2024

  • At the page Modelling the domain, an AggregateRoot is created to ensure uniqueness for Author email addresses, called Usernames. This is a Singleton. Why is this named plural? Other AggregateRoots are singular and this being a Singleton, I would expect it also being named Username instead.

Since it is a collection of usernames.

On top of that, as it's defined for the purpose of maintaining usernames (uniqueness of email addresses), would a name like UsernameMaintainer be more adequate?

It depends your domain experts. In this fictional case it was me and I chose Usernames as most appropriate name.

UsernameMaintainer sounds really technical to me, so I think UsernameList or Usernames is better.

@werdlerk werdlerk force-pushed the documentation-updates branch 4 times, most recently from 9109660 to 1376f45 Compare October 10, 2024 15:29
@werdlerk
Copy link
Member Author

werdlerk commented Oct 10, 2024

We need to add a graphic overview of all the steps that the blog application and sequent does for creating an Author and storing an AuthorRecord.
Something like the graphic from the Lars and Bob’s presentation at GOTO Amsterdam (page 34).

@werdlerk werdlerk force-pushed the documentation-updates branch from 1376f45 to 1ba928a Compare October 10, 2024 15:39
Fixes:
- The following actions uses node12 which is deprecated and will be forced to run on node16: actions/checkout@v2. For more info: https://github.blog/changelog/2023-06-13-github-actions-all-actions-will-run-on-node16-instead-of-node12-by-default/
- The following actions use a deprecated Node.js version and will be forced to run on node20: actions/checkout@v2. For more info: https://github.blog/changelog/2024-03-07-github-actions-all-actions-will-run-on-node20-instead-of-node16-by-default/
/Users/koen/.asdf/installs/ruby/3.3.5/lib/ruby/3.3.0/json/common.rb:3: warning: ostruct was loaded from the standard library, but will no longer be part of the default gems starting from Ruby 3.5.0.
You can add ostruct to your Gemfile or gemspec to silence this warning.
… link

It's weird that the default project is linking to the sequent gem using git instead of using the most recent officially released version of the gem.
@werdlerk werdlerk force-pushed the documentation-updates branch 2 times, most recently from e69b999 to 9c1d3ce Compare October 14, 2024 13:06
@werdlerk werdlerk force-pushed the documentation-updates branch from 8094337 to 4346a68 Compare October 14, 2024 13:07
@werdlerk werdlerk marked this pull request as ready for review October 15, 2024 15:17
Copy link
Member

@lvonk lvonk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice work ❤️ .

docs/_data/navigation.yml Outdated Show resolved Hide resolved
docs/docs/building-a-web-application.md Show resolved Hide resolved
docs/docs/building-a-web-application.md Show resolved Hide resolved
@werdlerk werdlerk merged commit 20fac1a into master Oct 17, 2024
11 checks passed
@werdlerk werdlerk deleted the documentation-updates branch October 17, 2024 10:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants