Move the new diffs blueprint to the correct folder structure
What does this MR do and why?
Move the new diffs blueprint to the correct folder structure so that it displays in the table of blueprint documents.
Also, list all the DRIs and contributing authors.
Merge request reports
Activity
added Architecture Evolution Blueprint docs-only documentation groupcode review + 1 deleted label
requested review from @aqualls
assigned to @thomasrandolph
added devopscreate sectiondev labels
changed milestone to %16.7
1 Warning This merge request is quite big (635 lines changed), please consider splitting it into multiple merge requests. 2 Messages This merge request might require a review from a Coach Engineer. This merge request adds or changes documentation files. A review from the Technical Writing team before you merge is recommended. Reviews can happen after you merge. Architecture Evolution Review
This merge request might require a review from a Coach Engineer.
Following files, that may require the additional review, have been changed:
doc/architecture/blueprints/new_diffs/index.md
doc/architecture/blueprints/new_diffs.md
Documentation review
The following files require a review from a technical writer:
-
doc/architecture/blueprints/new_diffs/index.md
(Link to current live version) -
doc/architecture/blueprints/new_diffs.md
(Link to current live version)
The review does not need to block merging this merge request. See the:
-
Metadata for the
*.md
files that you've changed. The first few lines of each*.md
file identify the stage and group most closely associated with your docs change. - The Technical Writer assigned for that stage and group.
- Documentation workflows for information on when to assign a merge request for review.
If needed, you can retry the
danger-review
job that generated this comment.Generated by
DangerEdited by Ghost User- Resolved by 🤖 GitLab Bot 🤖
Proper labels assigned to this merge request. Please ignore me.
@thomasrandolph - please see the following guidance and update this merge request.1 Error Please add typebug typefeature, or typemaintenance label to this merge request. Edited by 🤖 GitLab Bot 🤖
added typemaintenance label
@aqualls It appears (to me) that the failing job is due to these lines in the output log:
INFO: Merge request pipeline detected. Testing only the following files: doc/architecture/blueprints/new_diffs.md doc/architecture/blueprints/new_diffs/index.md
It then fails because
doc/architecture/blueprints/new_diffs.md
doesn't exist.That's correct, that file has been deleted in this MR.
It looks to me like the scanner for which files to parse needs an upgrade to skip files that have been deleted!Edited by Thomas Randolph@thomasrandolph you and @iamphill are trying to solve the same problem. He's over in Moves the new diffs architecture blueprint file (!138322 - closed).
Here's the answer: you're missing a redirect. !138322 (comment 1674320421) explains how to add it.
@aqualls Ah. Hm. An unexpected extra step.
I would typically think redirects should be done at the path-matching level (e.g.
/new_diffs.html /new_diffs/index.html 301
) rather than by scattering artifact files around that will SURELY rotAnyway, not important for now in this MR.
I think this is ready for your review now!
@thomasrandolph I have happy news for you, then: the TW team has an automated cleanup process for them! It's run as part of our monthly chore set. (See technical-writing#945 as an example.)
DRY_RUN=true bundle exec rake docs:clean_redirects // check the results before proceeding bundle exec rake docs:clean_redirects
Examples of the cleanups happening:
-
Clean up docs redirects, ee - 2023-11-29 (!138223 - merged) in the
gitlab
repo. This MR deletes expired redirect files, and it forces us to clean up any links that break as a result -
Clean up docs redirects - 2023-11-29 (gitlab-docs!4435 - merged) in the
gitlab-docs
repo transfers those now-deleted redirects tocontent/_data/redirects.yaml
, and date-stamps when the redirect should be removed for realsies.
-
Clean up docs redirects, ee - 2023-11-29 (!138223 - merged) in the
@aqualls Nice, I'm glad it's automated!
My concern was more like: "This seems like 301 redirects but with more steps." I don't know the server that runs the docs site, obviously, but I would hope (
) it could easily handle basic redirects like this. Is there a UX reason we want people to land on a page that's just a link somewhere else? (and search engines to index the old page instead of following a 301 and indexing the new one as canonical?)this seems like 301 redirects with more steps
@thomasrandolph Yep, you described it correctly. I have a vague memory that GitLab Pages doesn't support
.htaccess
files so a workaround had to be constructed? I'm trying to find the current / source issue and I've gotten this far:- Allow per-site custom configuration of GitLab P... (gitlab-pages#57)
- Add simple redirect configuration (gitlab-pages#24 - closed)
- Add docs for Gitlab Pages Redirects (!42011 - merged)
- https://docs.gitlab.com/ee/user/project/pages/redirects.html
That jibes with https://gitlab.com/gitlab-org/gitlab-docs/-/blob/main/content/_data/redirects.yaml - I don't see any HTTP status codes in there so they're all
301 Moved Permanently
.I'm going to resolve this thread not because we're done talking, but because I want to get your work merged. Don't interpret this as me shutting down discussion!
Hi
@aqualls
,GitLab Bot has added the Technical Writing label because a Technical Writer has approved or merged this MR.
This message was generated automatically. You're welcome to improve it.
added Technical Writing label
added docsimprovement maintenancerefactor tw-weight5 twfinished labels
mentioned in commit 4a0cb3b3
mentioned in merge request !138322 (closed)
added workflowstaging-canary label