1. You are here:
2. Handbook
3. Marketing
4. Digital Experience Handbook
5. Buyer Experience Repository

On this page

• Overview
  • Technical Architecture
  • Scope
  • Requesting Help when the Information Architecture Refresh Impacts your Work
• Content Editing Experience
  • Where Content Exists
  • How to Edit Content
  • How to Add a New Webpage
  • Will there be a content management system?
• Developer Experience
  • Where Developer Documentation Exists
  • How It Works with www-gitlab-com

Overview

Technical Architecture

1. Nuxt.js: A vue.js static site generator
2. Slippers Design System Integration: SSoT for vue.js components:
3. Focus Resources: Devoted to two repositories
   • Digital Experience focused resources on the Buyer Experience and Slippers repositories.

Scope

1. Move 80 marketing webpage to the Buyer Experience repository.
   1. Pricing
   2. Homepage
   3. Free Trial
   4. Sales
   5. Demo
   6. Install
   7. Features (Landing and single)
   8. Topics (Landing and single)
   9. Solutions (Landing and single)
   10. Enterprise
   11. SMB
   12. Partners (Landing and single)
   13. Comparison Pages

See the Marketing Site Information Architecture Refresh epic for single source of truth of pages being migrated to this repository.

Requesting Help when the Information Architecture Refresh Impacts your Work

Other keywords that may help folks find this section when searching the handbook:

• Missing content on the marketing website
• My changes in the website get overwritten
• Can't find my files anymore
• Files were moved
• Information architecture migrated my content

In order to meet the goals of the information architecture refresh and serve the business, the Digital Experience team will need to move existing content, and in some cases, remove existing content.

We will do our best to find a solution that meets the business goals of the migration, and keeps your existing processes intact. We apologize in advance for any inconveniences incurred by this work. We will be doing our best to communicate with stakeholders in advance, but due to the scope of the migration, we may miss appropriate channels from time to time.

If we have moved or removed your content and it's causing problems for you, your team, customers, or other stakeholders, here are steps you can take to escalate these issues to us:

1. First, check the Buyer Experience repository and see if you can find corresponding YAML files for your content. The Web IDE editing experience will be the same as it was in the www-gitlab-com repository.
2. If you are unable to find or edit your content, or have additional concerns, please start by opening an issue in the Buyer Experience issues board.
3. For urgent requests, you can find our team in the #digital-experience-team Slack channel.

Content Editing Experience

Where Content Exists

All content is stored in the /content directory and can be accessed via the Nuxt content module

How to Edit Content

1. Edit content directly in the browser using GitLab Web Editor.
2. Alternatively, set up a local development environment and use the Nuxt content editing tools on your machine. Then commit your changes and make a merge request in GitLab.

How to Add a New Webpage

1. Check if the new page is part of our Site Architecture Plan. These are the only pages that will exist in the Buyer Experience repository. For all other pages, please head over to the www-gitlab-com repository instructions and add your page to the old static site.
2. If your page is part of an existing neighbourhood (i.e. /solutions/, /partners/, /topics/) the components will already be built for you. If it is a completely new page, please request support from the Digital Experience Team via this issue template.
3. Add the content of your page into the /content folder in a .yml file. Please follow existing indentation and convention.
4. Create an MR, and tag both an Engineer and a Designer on the Digital Experience Team as a Reviewer. Only the Digital Experience Team will be able to merge.

Will there be a content management system?

Probably not. As we reduce the size and scope of the marketing site, we will be raising the bar for the quality of our page design. Content management systems present significant challenges in quality control.

In order to keep the Buyer Experience looking as good as possible, we have decided not to allow for markdown or rich text editing experiences. Instead, all data will continue to be rendered with the aforementioned Nuxt Content Module. Most data should live in YAML files as structured blocks of strings. There may be call for some numerical data from time to time. We will not allow or support markdown or other rich text strings, with the notable exception that some text elements may need inline links, which we can store as single p tags with anchors in them, and render with Vue.js v-html attributes.

By making this decision, we will be simplifying and streamlining our architecture, and making changes to the website more predictable and manageable. The cost is that some content editors may need to wait longer for engineers to implement their changes. Fortunately, in 2022, we only saw about 2-3 requests per month that required this kind of work across the Buyer Experience repository and www-gitlab-com repository.

If, in any particular quarter, we spend more than two weeks doing content updates implemented by engineering, we should revisit the need for a content management system.

Developer Experience

Where Developer Documentation Exists

The README.md at the repository root and our /docs directory.

How It Works with www-gitlab-com

See /docs/deployments.md.