Skip to content
Snippets Groups Projects
New look: Off

Create area for Solution docs

    • Closed Issue created by Suzanne Selhorn @sselhorn

    The solution architects would like an area to publish information.

    The main docs site is meant primarily for feature documentation. However, there are needs for different documentation types that fall outside of feature content.

    In the long term, it would make sense for solutions to be in a separate location, with separate index and nav capabilities. (See various possible future states for the docs site/layout in this issue.)

    However, as an MVC, we can help support the publishing of this information.

    Action items

    • Create a directory under /doc in the gitlab repo. Call it solutions. - Suzanne !135882 (merged)

      • All content should be in subfolders under this folder.
      • Use top-level folders with index.md files when needed.
      • All images should be in img folders and be less than 150k.
      • See the style guide for details.

    • Left nav: Add an area at the top level. It would be the final top-level item in the nav. Named Solutions. - Suzanne gitlab-docs!4371 (merged)

    • Search: Add checkbox for "Solutions" as a filter option on the search results page. - Sarah gitlab-docs!4370 (merged)

    • Tier badge: Automatically populate these pages with a tier badge that says Solution - Sarah gitlab-docs!4370 (merged)

    • Use this metadata for these pages. Update our rake task/Codeowners to include this group. - Sarah !136223 (merged)

      ---
stage: Solutions Architecture
group: Solutions Architecture
info: This file is owned by the Solutions Architecture team.
---

    • Update Dangerbot to not ping for these files. - Sarah !135984 (merged)

    • New: Update Dangerbot to have a specific message. - Sarah #431248 (closed) !136768 (merged)

    • Update style guide and handbook pages to list that TWs don't edit these pages. - Suzanne !136129 (merged) gitlab-com/content-sites/handbook!1129 (merged)

    • Create label called Solutions so they can use it to separate their MRs from the rest.

    Open questions

    • Susan, do we want this content represented in the content audit?
      • Susan: If it's on the site, it needs to be in the audit. Please let me know if this gets unwieldy(er).
    • Susan, should broken links in this area of the docs be included in our monthly update scripts? By default, they will be.
      • Susan: Hmm. I'm not sure what kinds of links they'll have. Hard to answer.
    • Susan/Darwin, is there a timeline that this must be done by?
      • Susan: AWS ReInvent is Nov 27. Finishing before that date will give architects time to share out URLs.
    • Darwin, what's the gitlab group we can use as CODEOWNERS for this folder? These people will be listed in the approval list for MRs that affect files in this folder and subfolders. (Does the metadata listed above look OK to you?) - Please use usernames - @jfullam @brianwald @Darwinjs
    ✓ 9 of 9 checklist items completed · Edited

    Designs

    Child items ...

    • Activity

    Please register or sign in to reply