Serve the needs and interests of our key audiences:
Generate demand for GitLab by:
The website does not include
See Where should content go? to learn which web property is the most appropriate place to put different types of content. To learn what section of the website different content belogs see definitions.
A topic is an industry trend, theme, or technology related to GitLab and our customers. For example, DevOps, GDPR, Containers, etc. Topic pages on our website educate the reader about the topic and share GitLab’s point of view while providing additional links to resources related to that topic. These pages are intended to attract search traffic.
Topic pages should exist at the root level of the website without being nested inside of another directory. e.g.
Examples of other companies who have topic pages:
A solution is a combination of products and services that solve a business problem. For example, accelerating software delivery, enabling remote teams, ensuring compliance, etc. Solution pages on our website show the application of GitLab capabilities and services to address a business problem while providing additional links to resources related to that solution.
Solution pages should be nested inside of the solutions directory. e.g.
Examples of other companies who have solutions pages:
The product section of our website has pages that describe what GitLab does and the value provided. The functionality of GitLab is ordered in a hierarchy with 4 levels: Stage, Categories, Capabilities, and Features. You can find details on the Product Categories Handbook
Category pages should be nested inside of the product directory. e.g.
Similar content can appear as a topic, solution, and in the product section with different emphases on each page. For example continuous integration:
/continuous-integrationwould talk about what CI is at a functional level.
/solutions/continuous-integration. would talk about why CI is important for businesses to adopt.
/product/continuous-integrationwould talk about the capabilities and features that are part of GitLab's CI functionality and the value it has.
Everyone can contribute to the marketing website. While the Product Marketing and Pipe-to-Spend teams have primary responsibility over the website, the goal of these teams is to build systems, structures, and processes and empower everyone to contribute. Below is a breakdown of the ownership between Product Marketing and Pipe-to-Spend.
.free-trial-homepage-button, rather than use a class that also distinguishes a buttons style e.g.
.accentetc. Using unique class names to track can also accompany classes that give the proper style. Classes on buttons we track should look something like this:
HPfor the homepage. If you have an update to any of the pages in the
Doingcolumn contact @lbanks. More details on CRO and testing in the Online Growth Handbook section
Use consistent language across the site when naming links, page names, directory names, page titles, etc. If you see inconsistent language, log an issue to correct. We use american english on the site. Here are some examples below. If in doubt, ask in the
#marketing slack channel for language help.
Do use nouns when appropriate
Do use the imperative tense as much as possible
Don't use noun forms of verbs
Don't use present participle ("ing" words)
Nouns may end in "ing"
Use MVCs to update the website. Create new pages and add the minimal amount of viable content. You can add images and more content in iterative steps.
We have 10-20 seconds to tell visitors why they should stay on our pages. Tell visitors what value the page will give them. Start with a high-level summary opening the page. This could be as simple as a single sentence, but we shouldn’t put the burden of discovering the value of the page on visitors.
The page title and URL should include keywords visitors might use to discover the page you’re creating. If you’re not sure what terms a visitor might use, ask the Online Growth team for suggestions in your Merge Request. We have a list of high priority topics and recommended keywords to use.
Here's a video that shows a typical workflow to update the website
To create a new page you for follow these steps:
sourcefolder. This is where webpages are stored.
sourcefolder it will show up at the "root" level, if you create the new directory inside of another directory it will will appear at that path.
New directoryfrom the plus sign drop down.
solutionsdirectory and inside the
solutionsdirectory create a new directory called
New filefrom the plus sign drop down
--- layout: markdown_page title: "" --- ## Subheading Here is your first paragraph replace this text.
.gitkeep. Delete the
.gitkeepfile. This is a placeholder file from when you created the directory since git cannot track empty directories. A quick way to delete the file on the correct branch is to click on "edit" in the changes tab of your MR. This will open the file editor. click "cancel" and dismiss the popup that says "all changes will be lost". This will then place you in the file view for the
.gitkeepfile on your branch. Click the "delete" button to delete the file.
/pricingor any pages related to your page.
haml, or possibly in a separate
.ymlfile that populates fields in the
hamlfile. The hello bar is an example of content in a
Great care should be taken whenever moving pages on the website. Ideally, pages should never be moved without implementing an immediate 301 redirect. The following instructions are a stop-gap until marketing can gain the ability to self-sever 301 redirects.
@lbankson your MR so that she can adjust paid campaigns to the new URL.
WARNING: Do not merge without LJ's approval because it will break paid advertising.
@jgragnolato adjust Marketo to know about the new URL.
WARNING: Do not merge without Jackie's approve because it will break lead flow.
git grepto find all the of links for example
git grep /team/
index.html.hamlfile in the old directory
/path/with the correct path:
#productionslack channel run the
!oncall productionslack command to see who is on call.
index.html.hamlpage with the JS redirect.
When adding an image to a webpage, be sure that you optimize the image first.
team.ymland create an MR
All features and capabilities are listed in a single yaml file (
features.yml) under the
features section. It is the single source of truth for multiple pages across the website including:
To add a new feature, add a feature block to under the
features: section of the page. Add the following attributes:
falseis this feature or capability available in this tier?
falseis this feature or capability available on GitLab.com? Because GitLab.com tiers map 1:1 to self-managed tiers setting this will automatically assign the GitLab.com tier. E.g.
GitLab.com Free. Adding a tiers fields is what powers the tier badges on product pages and comparison pages, as well as powers the tier feature comparison of the pricing page.
partially- any tool from the
competitors:section such as
blackduck:, etc. that does or does not have this feature. Examples of
partiallyare if a competitor has some but not all of the feature described, or if they have the feature, but only through a plugin. See Creating a comparison page
|pricing_page: || |
- title: "Group Milestones" description: "Create and manage milestones across projects, to work towards a target date from the group level. View all the issues for the milestone you’re currently working on across multiple projects." link_description: "Learn more about Group Milestones" link: https://docs.gitlab.com/ee/user/project/milestones/ screenshot_url: 'images/feature_page/screenshots/28-group-milestones.png' solution: plan category: - portfolio_management gitlab_core: true gitlab_starter: true gitlab_premium: true gitlab_ultimate: true gitlab_com: true github_com: false github_enterprise: false bitbucket_org: false bitbucket_data_center: false gogs: false jira: false ca_agile_central: false
Copy and paste this template:
- title: "" description: "" link_description: "" link: screenshot_url: '' solution: category: - gitlab_core: gitlab_starter: gitlab_premium: gitlab_ultimate: gitlab_com: github_com:
/devops-tools section of the website shows info about DevOps tools and a feature comparison of those tools to Gitlab. Comparison pages are auto-generated from
features.yml. All you need to do is add a tool to the
competitors section and add that tool id to some features and the page will be created.
To add a new comparison page:
competitorssection add a tool.
Although the summary and include_file fields are not strictly required by the parser in order to build the page, every tool should have at least one paragraph summarizing the comparison.
|) then add content in markdown indented on the next line. Be sure to add on additional empty line after your content.
.md) file that will be embedded on the page. Here is where you can add more robust content about the tool. Please use the template under
/source/devops-tools/misc/tool-template.html.mdand store your new file under
jenkins: name: 'Jenkins' logo: '/images/devops-tools/jenkins-logo.svg' category: - ci - cd include_file: devops-tools/jenkins/index.html.md chef: name: 'Chef' logo: '/images/devops-tools/chef.png' category: - infrastructure_configuration summary: | Chef is a configuration management tool that enables deployment and maintenance of state for large scale infrastructure. Chef excels as managing legacy infrastructure like physical servers and VMs. Chef was designed before widespread container adoption and does not implement Kubernetes natively. GitLab is a single application for the whole DevOps lifecycle that includes not only configuration management, but also capabilities for project management, source code management, CI/CD, and monitoring. GitLab is designed for Kubernetes and cloud native applications. GitLab can be used together with Chef to enable VM and bare metal configuration management. For Cloud Native applications run on Kubernetes, Chef is not required and GitLab can provide all the functionality natively.
Copy and past this template:
unique_tool_id: name: logo: '/images/logos/' category: - summary: |
Be sure to add features that GitLab has that the other tool doesn't and also features the other tool has that GitLab doesn't so that our comparison are transparent and honest.
partiallyto indicate support for the feature. Add the same details for gitlab tiers. Adding a tool id to a feature is what causes it to show up on the comparison page for that tool. (e.g. if you don't want a feature to show up on a comparison page remove the tool id line from that feature.)
- title: "Free CI/CD with shared or personal Runners" capability: true description: "GitLab.com has shared Runners that allow you to use GitLab CI/CD completely free up to 2000 build minutes for private projects and unlimited for public projects. Alternatively, you can set up your own Runner for faster build processing, unlimited build minutes, or special requirements." link_description: "Explore GitLab.com offerings" link: /gitlab-com solution: gitlab_com gitlab_core: true gitlab_starter: true gitlab_premium: true gitlab_ultimate: true gitlab_com: true github_com: false bitbucket_org: 'partially' gitlab_ci: true codestar: false - title: "Domain Specific Language" description: "A Domain Specific Language (DSL) for defining infrastructure configuration allows thinking in resources, not files or commands to write declarative rather than procedural code." # link_description: "" # link: '' solution: missing gitlab_core: false gitlab_starter: false gitlab_premium: false gitlab_ultimate: false puppet: true chef: false
/devops-tools/tool-vs-gitlab.htmland you should see it in the dropdown menu. The last thing you need to do is create the PDF. Follow the info in creating comparison PDFs.
/resources section of the website contains downloadable files and links to helpful content.
- title: url: image: /images/resources/gitlab.png type: Pick one --> 'Blog post' 'One-pager' 'Report' 'Webcast' 'White paper' topics: - Cloud native - Code review - Continuous delivery - Continuous integration - DevOps - Git - GitLab - On-demand training - Public Sector - Security - Software development solutions: - Distributed teams - Accelerated delivery - Executive visibility - Project compliance - Security and quality
Uploading a PDF: If the resource you'd like to add is a PDF, it can be uploaded to
Selecting an image: Each resources has a thumbnail image based on their topic; select the most relevant image for the content. The current thumbnail images are shown below and can be found here.
Selecting a type: All resource types are listed in the code snippet above; select one that best fits your content. If the resource does not fit the current types, please see Requesting Website Updates to submit a proposal for new resource type(s).
Selecting topics & solutions: The code snippet above provides all of the current topics and solutions; chose the topics and solutions that best apply to the content. Please note they are case sensitive and incorrect casing or spelling will result in the generation of new, unwanted, topics and/or solutions.
If you'd like to propose new changes to the website and the update is more complicated that you can do on your own to either create a new page or update and existing page you can request help from the Website team. New changes or updates with a due date should be requested at least 2 weeks prior to that due date.