- Issue created by @eojthebrave
- Merge request !82Initial pass at example pages for future Drupal CMS Guide. β (Merged) created by eojthebrave
- Status changed to Needs work
7 months ago 10:14pm 10 September 2024 - πΊπΈ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.
- .DS_Store is in there. Go ahead and add
- Status changed to Needs review
7 months ago 2:48pm 11 September 2024 - πΊπΈ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.
- πΊπΈ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.
- πΊπΈ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.
- πΊπΈ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.
- Issue was unassigned.
- Status changed to RTBC
7 months ago 4:45pm 11 September 2024 - πΊπΈUnited States phenaproxima Massachusetts
Okay, well...adding an explicit
on_success
rule to every job seems to have fixed it. Cool. -
phenaproxima β
committed 2c7c60a6 on 0.x authored by
eojthebrave β
Issue #3473439 by eojthebrave, phenaproxima: Create a few POC pages for...
-
phenaproxima β
committed 2c7c60a6 on 0.x authored by
eojthebrave β
- Status changed to Fixed
7 months ago 4:54pm 11 September 2024 - πΊπΈ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
eojthebrave β credited amber himes matz β .
- πΊπΈ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.