Create a few POC pages for a future Drupal CMS Guide

Created on 10 September 2024, 7 months ago
Updated 11 September 2024, 7 months ago

Problem/Motivation

In order to have something to demonstrate we should create a couple of proof of concept documentation pages that represent what a future Drupal CMS Guide might look like.

We (Amber, Addi, and I) have been working with Lenny (DA) and Martin (Events track lead) to come up with some best in class examples of what documentation targeted at the Starshot target audience (ambitious site builders / marketing exec, etc.) would look like. And have drafted a few pages as Markdown. For now this content can be used to create demos, and as a starting point for discussion of future plans.

In addition this contains the start of a POC table of contents for a larger Drupal CMS Guide.

Long term we can work out things like file naming conventions, setting this up via mkdocs, etc. But for now we'll just focus on getting some example pages completed.

πŸ“Œ Task
Status

Fixed

Component

Documentation

Created by

πŸ‡ΊπŸ‡ΈUnited States eojthebrave Minneapolis, MN

Live updates comments and jobs are added and updated live.
Sign in to follow issues

Merge Requests

Comments & Activities

  • Issue created by @eojthebrave
  • Pipeline finished with Canceled
    7 months ago
    Total: 150s
    #279643
  • Status changed to Needs work 7 months ago
  • πŸ‡ΊπŸ‡ΈUnited States phenaproxima Massachusetts

    A couple of things I notice right off the bat:

    • .DS_Store is in there. Go ahead and add .DS_Store to the top-level .gitignore file, so we can swat this problem away.
    • An automatic spell check would be great. It could happen in a follow-up, but ideally there'd be a CI task that runs a spell checker on the /docs dir if anything in it changes.
    • Add one or two of you to CODEOWNERS for the /docs/ directory.
  • Pipeline finished with Success
    7 months ago
    Total: 5801s
    #279647
  • Pipeline finished with Failed
    7 months ago
    #280234
  • Pipeline finished with Failed
    7 months ago
    #280237
  • Status changed to Needs review 7 months ago
  • πŸ‡ΊπŸ‡ΈUnited States eojthebrave Minneapolis, MN

    Thanks for the feedback.

    I've cleaned up the .DS_Store file, added Amber and I to the CODEOWNERS file for the /docs directory. And added a job to run cpsell on the docs directory. This is my first time setting up cspell + GitLab so while it's working, and passes, that part could use a review.

    At some point in the future I think we should look at tooling that not only checks spelling but also enforces a style guide (always use Drupal, never drupal, always write "contributed module" never "contrib module", etc.) But for now I think cspell does enough.

    Ready for another review!

  • πŸ‡ΊπŸ‡ΈUnited States phenaproxima Massachusetts

    That looks pretty good to me, but I'm wondering about how the CI job is put together - it looks strangely complicated, compared to the other jobs, and maybe there's a reason for that but I'd like to understand it.

  • Pipeline finished with Success
    7 months ago
    Total: 980s
    #280240
  • πŸ‡ΊπŸ‡ΈUnited States eojthebrave Minneapolis, MN

    Sure! It's mostly copied from here https://git.drupalcode.org/project/gitlab_templates/-/blob/main/.gitlab-.... I found that while trying to figure out how cspell was being run for contrib projects. And while that's not the implementation in the gitlab templates for Drupal projects it seemed to work. :)

    Then I paired that job down to just the cspell related bits. It's probably possible to remove the `exit $EXIT_CODE` related stuff since it's only running a single check in this case instead of multiple. Let me try that and see what happens.

  • Pipeline finished with Canceled
    7 months ago
    Total: 330s
    #280263
  • πŸ‡ΊπŸ‡ΈUnited States eojthebrave Minneapolis, MN

    Sorry about the mess of commits. But I was able to simplify the GitLab CI config based on your suggestions and it's still working. Thanks.

  • πŸ‡ΊπŸ‡ΈUnited States phenaproxima Massachusetts

    That looks pretty good - let's just introduce a spelling error (temporarily) to prove it works. And then, the other concern is...er...why aren't any of the other pipeline jobs running??? That's strange.

  • Pipeline finished with Success
    7 months ago
    Total: 1019s
    #280272
  • Pipeline finished with Failed
    7 months ago
    Total: 813s
    #280288
  • πŸ‡ΊπŸ‡ΈUnited States phenaproxima Massachusetts

    Nice - that worked. Now we just gotta figure out why in the hell all the other jobs vanished.

  • πŸ‡ΊπŸ‡ΈUnited States eojthebrave Minneapolis, MN

    Yeah ... I have no idea how to debug that one. But as a trial I'm going to just remove all the changes to the .gitlab-ci.yml file that this MR introduces and see what happens. That should at least tell us if it's something related to those changes or not.

  • Pipeline finished with Canceled
    7 months ago
    Total: 208s
    #280323
  • Pipeline finished with Canceled
    7 months ago
    Total: 343s
    #280325
  • Pipeline finished with Canceled
    7 months ago
    Total: 266s
    #280333
  • Pipeline finished with Success
    7 months ago
    #280337
  • Pipeline finished with Canceled
    7 months ago
    Total: 327s
    #280367
  • Pipeline finished with Canceled
    7 months ago
    #280374
  • Issue was unassigned.
  • Status changed to RTBC 7 months ago
  • πŸ‡ΊπŸ‡ΈUnited States phenaproxima Massachusetts

    Okay, well...adding an explicit on_success rule to every job seems to have fixed it. Cool.

  • Pipeline finished with Success
    7 months ago
    Total: 541s
    #280378
  • Pipeline finished with Skipped
    7 months ago
    #280389
  • Status changed to Fixed 7 months ago
  • πŸ‡ΊπŸ‡ΈUnited States phenaproxima Massachusetts

    Nice. This is a great start to some killer documentation, it's wonderful to see this materialize. Let's goooooo!

  • πŸ‡ΊπŸ‡ΈUnited States Amber Himes Matz Portland, OR USA
  • πŸ‡ΊπŸ‡ΈUnited States eojthebrave Minneapolis, MN

    Woohoo! Thanks for sorting out that CI weirdness. πŸŽ‰

    Adding credit for Amber who helped with copy editing and reviewing the content.

  • Automatically closed - issue fixed for 2 weeks with no activity.

Production build 0.71.5 2024