Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CONTENT_AUTHORING.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ The CircleCI documentation is organized into logical components, each focusing o
| `reference` | API and configuration references | `docs/reference/` |
| `orbs` | CircleCI orbs documentation | `docs/orbs/` |
| `server-admin` | Server administration guides | `docs/server-admin-4.*/` |
| `services` | Field engineering service information | `docs/services` |
| `contributors` | Contributor guidelines | `docs/contributors/` |

### File Organization
Expand Down
2 changes: 2 additions & 0 deletions antora-playbook.yml
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,8 @@ content:
start_path: docs/server-admin-4.3
- url: .
start_path: docs/server-admin-4.2
- url: .
start_path: docs/services
- url: .
start_path: docs/contributors
ui:
Expand Down
6 changes: 6 additions & 0 deletions docs/services/antora.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
name: services
title: Services
version: ~
nav:
- modules/ROOT/nav.adoc
start_page: ROOT:services-overview.adoc
20 changes: 20 additions & 0 deletions docs/services/modules/ROOT/nav.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
* xref:services-overview.adoc[Field engineering services overview]

* Services
** xref:services:optimization-assistance.adoc[Optimization assistance]
** xref:services:onboarding-assistance.adoc[Onboarding assistance]
** xref:services:migration-assistance.adoc[Migration assistance]
** xref:services:config-review.adoc[Configuration review]
** xref:services:config-translation.adoc[Configuration translation]
** xref:services:cost-optimization.adoc[Cost optimization]
** xref:services:technical-consultation.adoc[Technical consultation]
** xref:services:custom-service.adoc[Custom service]
** Server assistance
*** xref:services:server-installation.adoc[Server installation]
*** xref:services:server-migration.adoc[Server migration]
*** xref:services:server-operator-training.adoc[Server operator training]

* Training
** xref:services:general-developer-training.adoc[General developer training]
** xref:services:reusable-config-training.adoc[Reusable configuration training]
** xref:services:usage-api-training.adoc[Usage API training]
37 changes: 37 additions & 0 deletions docs/services/modules/ROOT/pages/services-overview.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
= Field engineering services overview
:page-description: Field engineering services overview

== Field engineering team

The field engineering team at CircleCI includes customer engineers with DevOps and systems administration experience. They focus on making pipelines as efficient as possible. Field engineers work with CircleCI's largest and most complex customers to solve their challenges.

== Field engineering services

Field engineering services include engagements led by your field engineer, from consultation to training. Services come bundled with your support plan. Organizations without a support plan can select services on an individual basis. For more information please contact our link:https://circleci.com/contact/[Sales team].

The following services are provided by the Field Engineering team:

* xref:services:migration-assistance.adoc[Migration assistance]
* xref:services:onboarding-assistance.adoc[Onboarding assistance]
* xref:services:cost-optimization.adoc[Cost optimization]
* xref:services:config-translation.adoc[Configuration translation]
* xref:services:config-review.adoc[Configuration review]
* xref:services:optimization-assistance.adoc[Optimization assistance]
* xref:services:general-developer-training.adoc[General developer training]
* xref:services:reusable-config-training.adoc[Reusable configuration training]
* xref:services:usage-api-training.adoc[Usage API training]
* xref:services:technical-consultation.adoc[Technical consultation]
* xref:services:custom-service.adoc[Custom service]
* xref:services:server-installation.adoc[Server installation]
* xref:services:server-migration.adoc[Server migration]
* xref:services:server-operator-training.adoc[Server operator training]


== Support plans

We offer support plans from self-serve to fully managed. Refer to our link:https://circleci.com/support/plans[support plan page] for details.

To see your current support plan tier, CircleCI admins can:

. In the link:https://app.circleci.com/home/[CircleCI web app], select your organization.
. Select **Plan** in the sidebar (you may need to select **More** to see **Plan**).
40 changes: 40 additions & 0 deletions docs/services/modules/services/pages/config-review.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
= Configuration review service
:page-platform: Advanced Support, Premium Support, Advisory Services
:page-description: Configuration review service

The configuration review service evaluates a single CircleCI project and delivers a findings report. Your field engineer meets with the team that manages the project to learn about the use case and goals. After a two-week analysis, depending on the size of the project, your field engineer delivers findings. If additional help is needed to implement requirements, additional consultative time is scheduled.

Findings typically include:

* Optimization recommendations tied to your goals, such as cost savings or performance.
* Feature options for your use case.
* Right-fitting execution environments.
* DRY (Don't Repeat Yourself) recommendations.
* Solutions specific to your project's use case.
* How your field engineer uses CircleCI data to analyze the project.

== Benefits

Teams who engage in a configuration review benefit from:

* A more optimized CI/CD pipeline that improves spend and engineering efficiency for the reviewed project.
* Best practices tailored to the project's use case.
* More self-service to apply improvements across current and future projects.
* Proactive identification of knowledge gaps, training needs, or service requirements.
* Faster user onboarding in the reviewed project.
* A clearer understanding of CircleCI data and how to use it.

== Intended audience

Configuration reviews are most useful for projects that:

* Started using CircleCI in the last six months.
* Have made a recent major change to their configuration.
* Have a heavy throughput.
* Contain complex pipelines.
* Are used as a template for other projects.
* Are showing negative metric trends.

Anyone responsible for writing or maintaining the CircleCI configuration for the reviewed project should be involved.

Developers who work on the project can gain a clearer understanding of what CircleCI does under the hood.
20 changes: 20 additions & 0 deletions docs/services/modules/services/pages/config-translation.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
= Configuration translation service
:page-platform: Premium Support, Advisory Services
:page-description: Configuration translation service

The configuration translation service is an engagement where your field engineer translates a project's configuration from another CI tool into CircleCI configuration. Each service translates one project configuration.

== Benefits

Teams who take advantage of a configuration translation service save time by:

* Having their field engineer write their CircleCI configuration.
* Getting example configurations for migrating projects written by CircleCI experts.
* Working with their field engineer to research how to use CircleCI for their use case.
* Adding their field engineer to the migration team for advice on CircleCI aspects of the migration.

== Intended audience

This training is for teams bringing a new project onto CircleCI.

Direct contributors to the migration effort for the translated project should be involved.
23 changes: 23 additions & 0 deletions docs/services/modules/services/pages/cost-optimization.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
= Cost optimization analysis service
:page-platform: Advanced Support, Premium Support, Advisory Services
:page-description: Cost optimization service

The cost optimization analysis service helps reduce credit spend for jobs with high usage. Your field engineer reviews jobs across projects and recommends optimizations using CircleCI data. The service highlights credit-saving opportunities and recommends best practices.

== Benefits

Teams who take advantage of a cost optimization analysis save credits by:

* Receiving a report on jobs across projects that gain from right-sizing resource classes.
* Getting feature and caching recommendations for jobs across your organization.
* Working with their field engineer to analyze jobs across the organization.
* Learning how your field engineer uses CircleCI data to analyze your organization.

== Intended audience

A cost optimization analysis is most useful for organizations that:

* Are seeing unexpected increases in credit usage.
* Do not have a single team responsible for DevOps management.
* Have made a recent major change to their pipelines.
* Want a top-down understanding of data in their highest-credit projects.
18 changes: 18 additions & 0 deletions docs/services/modules/services/pages/custom-service.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
= Custom service
:page-platform: Premium Support, Advisory Services
:page-description: Custom service

The custom service is an engagement where your field engineer works with your team to build a service that supports your DevOps goals. Examples include a adding new tool, adding a security practice, or a CircleCI feature migration.

== Benefits

Teams that work with their field engineer to create a custom service:

* Meet their DevOps goals faster with expert advice.
* Work with their field engineer to research how to use CircleCI for their use case.
* Are more agile when responding to changing priorities.
* Help the CircleCI community by identifying areas where your field engineer can assist other teams.

== Intended audience

Teams with a DevOps goal that has requirements outside the bounds of other field engineering services.
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
= General developer training
:page-platform: Advanced Support, Premium Support, Advisory Services
:page-description: General developer training service

General developer training includes two one-hour sessions led by your field engineer. The sessions cover CircleCI basics such as configuration, secrets management, and debugging failed builds.

Organizations with a premium support plan can customize the training. For example, they can add topics or focus on their specific pipelines.

== Benefits

Teams who attend a general developer training:

* Feel more confident using CircleCI.
* Understand what an optimized pipeline looks like.
* Understand how to troubleshoot their failed builds.
* Understand how to onboard new projects.
* Are taught by a CircleCI expert.


== Intended audience

This training is for users who are new to CircleCI, have a technical role, and use CircleCI routinely.
18 changes: 18 additions & 0 deletions docs/services/modules/services/pages/migration-assistance.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
= Migration assistance service
:page-platform: Premium Support, Advisory Services
:page-description: Migration assistance service

Migration assistance is a collection of engagements where your field engineer helps migrate projects to CircleCI with minimal disruption. Your field engineer works with you on a customized migration journey that includes configuration translations, best practice adoption, developer training, and more.

== Benefits

Teams that work with their field engineer to migrate their projects:

* Migrate to CircleCI faster using their field engineer's expert knowledge.
* Start with a more centralized approach to managing CircleCI.
* Work with their field engineer to research how to use CircleCI for their use case.
* Better understand how CircleCI works for their organization and the data it provides.

== Intended audience

Teams that are new to CircleCI and want expert assistance to plan and execute their migration.
18 changes: 18 additions & 0 deletions docs/services/modules/services/pages/onboarding-assistance.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
= Onboarding assistance service
:page-platform: Premium Support, Advisory Services
:page-description: Onboarding assistance service

Onboarding assistance is a collection of engagements where your field engineer helps your team use CircleCI comfortably and efficiently, with appropriate safeguards. Your field engineer works with you on a customized onboarding journey so CircleCI follows best practices for your use case.

== Benefits

Teams that work with their field engineer to onboard their organization:

* Adopt CircleCI faster using their field engineer's expert consultation.
* Start with a more centralized approach to managing CircleCI.
* Have their team trained by a CircleCI expert.
* Better understand how CircleCI works for their organization and the data it provides.

== Intended audience

Teams that are new to CircleCI or teams that are onboarding a large number of new projects.
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
= Optimization assistance service
:page-platform: Premium Support, Advisory Services
:page-description: Optimization assistance service

Optimization assistance is a collection of engagements where your field engineer helps your projects run optimally on CircleCI. Your field engineer works with your team on an optimization journey tailored to your goals. Over the course of this journey, your field engineer performs configuration reviews, trains your team, and ensures you have the data you need.

== Benefits

Teams that work with their field engineer to optimize their projects:

* Achieve their DevOps goals faster using their field engineer's expert knowledge.
* Run more efficient builds for their developers.
* Operate CircleCI more efficiently.
* Better understand how CircleCI works for their organization and the data it provides.

== Intended audience

Teams that already use CircleCI and want expert assistance to plan and execute their DevOps optimization goals.
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
= Reusable configuration training
:page-platform: Advanced Support, Premium Support, Advisory Services
:page-description: Reusable configuration training

Reusable configuration training is a one-hour session led by your field engineer. It teaches teams how to create configuration files that use YAML stored in centralized locations. The training covers centralized configuration management, orbs, and other reusable configuration features.

== Benefits

Teams who attend a reusable configuration training:

* Create clear, unified configuration files.
* Provide their development teams with a library of pre-written configuration.
* Reduce the maintenance overhead of managing configuration files in multiple repositories.
* Ease the onboarding process of new projects.

== Intended audience

This training is for teams that write and maintain configuration files across multiple repositories. Users responsible for their organization's CI configuration benefit the most.
19 changes: 19 additions & 0 deletions docs/services/modules/services/pages/server-installation.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
= Server installation service
:page-platform: Advanced Support, Premium Support, Advisory Services
:page-description: Server installation service

The server installation service is an engagement where your field engineer ensures an efficient process for installing a new instance of CircleCI Server. For teams starting with Server, the installation service streamlines setup and supports a smooth start. The service runs in phases, with multiple working sessions.

== Benefits

Teams that engage with their field engineer to install Server gain:

* Detailed assessment of infrastructure and prerequisites for Server installation.
* Deployment of the latest Server version, optimized for specific requirements.
* Configuration and fine-tuning of the server environment to ensure optimal performance.
* Integration with existing tools and systems to maintain workflow continuity.
* Thorough testing to validate the successful installation and functioning.

== Intended audience

This training is for server administrators setting up a new instance of CircleCI Server.
20 changes: 20 additions & 0 deletions docs/services/modules/services/pages/server-migration.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
= Server migration service
:page-platform: Advanced Support, Premium Support, Advisory Services
:page-description: Server migration service

The server migration service is an engagement where your field engineer guides CircleCI Server migrations. It covers major or minor version upgrades, cloud provider migrations, and new installations.

== Benefits

Teams that engage in a server migration service receive:

* A thorough analysis of the current setup and requirements.
* A customized migration plan to minimize downtime and potential disruptions.
* Data backup and transfer to ensure data integrity and continuity.
* Configuration of the new Server environment to match unique specifications.
* Rigorous testing to validate the migration and identify any issues before launch.
* Post-migration support and assistance to address any unforeseen challenges.

== Intended audience

This training is for server administrators setting up a migrating instance of CircleCI Server.
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
= Server operator training
:page-platform: Advanced Support, Premium Support, Advisory Services
:page-description: Server operator training

== Overview

The server operator training is a one-hour session led by your field engineer. It covers CircleCI Server functionality, the resources needed to set up a cluster, and effective instance management.

== Benefits

Teams that attend a server operator training:

* Learn how CircleCI Server is running in their organization.
* Understand how to troubleshoot basic issues.
* Understand how CircleCI Server operates from the administrative perspective and during execution.
* Know the best practices and advanced techniques to enhance the management of their CircleCI installations.

== Intended audience

This training is for server administrators who manage CircleCI Server instances.
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
= Technical consultation service
:page-platform: Advanced Support, Premium Support, Advisory Services
:page-description: Technical consultation service

The technical consultation service is an engagement where your field engineer focuses on a single challenge your team faces. The service provides an in-depth explanation of related features and proven solutions.

Technical consultation challenges the Field Engineering team have assisted with include:

* Config Policies: Implementing config policies to satisfy security requirements.
* Self-hosted Runners: Configuring self-hosted runners for specific use case.
* Usage API: Setting up an integration to injest CircleCI's data.
* Many other challenges.

== Benefits

A team engaging with us in a technical consultation benefits from:

* A platform to articulate your goals or challenges so your field engineer can understand your requirements in depth.
* Tested insights, recommendations, and potential solutions from your field engineer.
* A clear, customized action plan to solve important challenges, saving time and resources.

== Intended audience

This training is for teams with a CircleCI challenge. Your field engineer consults on the CircleCI aspects of that challenge.
Loading