forked from manishas/docsv2
-
Notifications
You must be signed in to change notification settings - Fork 0
/
mkdocs.yml
204 lines (200 loc) · 9.02 KB
/
mkdocs.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
# General
site_name: Shippable Docs
repo_url: https://github.com/Shippable/docsv2
# Paths
docs_dir: sources
theme_dir: theme/shippable
#detect broken links and break the build
strict: true
#Google Analytics
google_analytics: ['UA-50610279-1', 'auto']
# Pages
pages:
- Overview:
- What is Shippable?: index.md
- FAQ: faq.md
- Continuous Integration (CI):
- Overview: ci/overview.md
- What is supported?: ci/supported.md
- Running a build: ci/runFirstBuild.md
- Build configuration: ci/shippableyml.md
- Languages:
- Node.js: ci/languages/node.md
- Python: ci/languages/python.md
- Java: ci/languages/java.md
- Clojure: ci/languages/clojure.md
- Ruby: ci/languages/ruby.md
- Go: ci/languages/go.md
- PHP: ci/languages/php.md
- Scala: ci/languages/scala.md
- C: ci/languages/objc.md
- Custom Images: ci/languages/customImages.md
- Services:
- CouchDB: ci/services/couchDB.md
- Elastic Search: ci/services/elasticSearch.md
- Memcached: ci/services/memcached.md
- MongoDB: ci/services/mongoDB.md
- MySQL: ci/services/mySQL.md
- Neo4j: ci/services/neo4j.md
- Postgres: ci/services/postgreSQL.md
- RabbitMQ: ci/services/rabbitMQ.md
- Redis: ci/services/redis.md
- RethinkDB: ci/services/rethinkDB.md
- Riak: ci/services/riak.md
- Selenium: ci/services/selenium.md
- SQLite: ci/services/sqlite.md
- Advanced Options:
- Environment Variables: ci/advancedOptions/environmentVariables.md
- Including/Excluding branches: ci/advancedOptions/branches.md
- Matrix builds: ci/advancedOptions/matrixBuilds.md
- Caching: ci/advancedOptions/caching.md
- Artifacts: ci/advancedOptions/artifacts.md
- Using git submodules: ci/advancedOptions/gitSubmodules.md
- Shippable_retry: ci/advancedOptions/retry.md
- Skipping builds: ci/advancedOptions/skipBuild.md
- Running builds on your own machines (BYON): ci/advancedOptions/byon.md
- Test and Coverage Reports: ci/advancedOptions/testCoverage.md
- Timeouts: ci/advancedOptions/timeouts.md
- Console logs: ci/advancedOptions/console-logs.md
- Node Machine Images: ci/advancedOptions/machineImages.md
- Permissions: ci/permissions.md
- Troubleshooting CI: ci/troubleshoot.md
- Continuous Deployment Pipelines:
- Overview: pipelines/overview.md
- Getting Started: pipelines/gettingStarted.md
- Resources:
- Overview: pipelines/resources/overview.md
- cliConfig: pipelines/resources/cliConfig.md
- cluster: pipelines/resources/cluster.md
- dockerOptions: pipelines/resources/dockerOptions.md
- file: pipelines/resources/file.md
- gitRepo: pipelines/resources/gitRepo.md
- image: pipelines/resources/image.md
- integration: pipelines/resources/integration.md
- loadBalancer: pipelines/resources/loadBalancer.md
- notification: pipelines/resources/notification.md
- params: pipelines/resources/params.md
- replicas: pipelines/resources/replicas.md
- time: pipelines/resources/time.md
- version: pipelines/resources/version.md
- Jobs:
- Overview: pipelines/jobs/overview.md
- manifest: pipelines/jobs/manifest.md
- deploy: pipelines/jobs/deploy.md
- release: pipelines/jobs/release.md
- provision: pipelines/jobs/provision.md
- runSh: pipelines/jobs/runSh.md
- runCLI: pipelines/jobs/runCLI.md
- jenkinsJob: pipelines/jobs/jenkinsJob.md
- Triggers: pipelines/triggers.md
- Trace: pipelines/trace.md
- Integrations:
- Overview: integrations/overview.md
- Source Control Systems:
- Overview: integrations/scm/scmOverview.md
- GitHub: integrations/scm/github.md
- GitHub Enterprise: integrations/scm/githubEnterprise.md
- Bitbucket: integrations/scm/bitbucket.md
- Bitbucket Server: integrations/scm/bitbucketServer.md
- GitLab: integrations/scm/gitlab.md
- Notifications:
- Slack: integrations/notifications/slack.md
- Email: integrations/notifications/email.md
- HipChat: integrations/notifications/hipchat.md
- IRC: integrations/notifications/irc.md
- Webhooks: integrations/notifications/webhooks.md
- Image Registries:
- Docker Hub: integrations/imageRegistries/dockerHub.md
- Docker Trusted Registry: integrations/imageRegistries/dockerTrustedRegistry.md
- Amazon EC2 Container Registry (ECR): integrations/imageRegistries/ecr.md
- Google Container Registry (GCR): integrations/imageRegistries/gcr.md
- Quay.io: integrations/imageRegistries/quay.md
- Any Private Registry: integrations/imageRegistries/privateRegistry.md
- Artifact Registries:
- Jfrog Artifactory: integrations/artifactRegistries/jfrogArtifactory.md
- Container Services:
- Amazon EC2 Container Service (ECS): integrations/containerServices/ecs.md
- Kubernetes: integrations/containerServices/kubernetes.md
- Google Container Engine (GKE): integrations/containerServices/gke.md
- Docker Cloud: integrations/containerServices/dockerCloud.md
- Docker Datacenter: integrations/containerServices/dockerDatacenter.md
- Deploy:
- AWS Elastic Beanstalk: integrations/deploy/eb.md
- Node Cluster: integrations/deploy/nodeCluster.md
- Keys:
- SSH: integrations/keys/ssh.md
- PEM: integrations/keys/pem.md
- Navigating the UI:
- Home: navigatingUI/home.md
- Account:
- Account: navigatingUI/accountSettings/accounts.md
- Integrations: navigatingUI/accountSettings/integrations.md
- Cards: navigatingUI/accountSettings/cards.md
- API: navigatingUI/accountSettings/api.md
- Subscription:
- CI: navigatingUI/subscriptions/ci.md
- Pipelines: navigatingUI/subscriptions/pipelines.md
- Settings: navigatingUI/subscriptions/settings.md
- Project:
- Status: navigatingUI/projects/status.md
- Settings: navigatingUI/projects/settings.md
- Build:
- Overview: navigatingUI/builds/overview.md
- Detail: navigatingUI/builds/detail.md
- API:
- Overview: api/overview.md
- Account routes: api/account.md
- Subscription routes: api/subscription.md
- Project routes: api/project.md
- Job routes: api/job.md
- Run routes: api/run.md
- Status Code Mapping: api/statusMapping.md
- Shippable Server:
- Overview: server/overview.md
- Installing Shippable Server: server/installingShippableServer.md
- Backup and Restore Procedures: server/backup-restore-procedures.md
- Tutorials:
- CI tutorial Index: tutorials/continuous-integration.md
- CD Pipelines tutorial index: tutorials/continuous-delivery-pipelines.md
- CI Tutorials:
- Run a sample CI build: tutorials/ci/runSampleCIBuild.md
- Source Control Tutorials:
- Linking GitHub and Bitbucket accounts on Shippable: tutorials/ci/link-gitHub-bitbucket.md
- Building Bitbucket Server repos: tutorials/ci/scm-bitbucket-server-ci.md
- Building GitLab repos: tutorials/ci/scm-gitlab-ci.md
- Docker registry tutorials:
- Amazon ECR tutorials:
- Pull Docker image from ECR: tutorials/ci/hub-amazon-ecr-pull-docker-image.md
- Build docker image: tutorials/ci/hub-amazon-ecr-build-docker-image.md
- Push a Docker image to ECR: tutorials/ci/hub-amazon-ecr-push-docker-image.md
- Use custom Docker image from ECR for CI: tutorials/ci/hub-amazon-ecr-custom-ci-image.md
- Docker Hub tutorials:
- Pull image from Docker Hub: tutorials/ci/hub-docker-pull-image.md
- Build docker image: tutorials/ci/hub-docker-build-image.md
- Push an image to Docker Hub: tutorials/ci/hub-docker-push-image.md
- Use custom image from Docker Hub for CI: tutorials/ci/hub-docker-custom-ci-image.md
- GCR tutorials:
- Pull Docker image from GCR: tutorials/ci/hub-gcr-pull-docker-image.md
- Build docker image: tutorials/ci/hub-gcr-build-docker-image.md
- Push a Docker image to GCR: tutorials/ci/hub-gcr-push-docker-image.md
- Use custom Docker image from GCR for CI: tutorials/ci/hub-gcr-custom-ci-image.md
- Test and Code Coverage Tutorials:
- Advanced Coverage Reports with JaCoCo: tutorials/ci/code-coverage-jacoco.md
- Deploy Tutorials:
- Using Heroku: tutorials/ci/deploy-heroku.md
- Using OpsWorks: tutorials/ci/deploy-amazon-opsworks.md
- Using Code Deploy: tutorials/ci/deploy-amazon-codedeploy.md
- Using Digital Ocean: tutorials/ci/deploy-digital-ocean.md
- Pipelines Tutorials:
- Deploying a sample application: tutorials/pipelines/samplePipeline.md
- Seeding your first pipeline: tutorials/pipelines/howToAddSyncRepos.md
- Connecting CI and Pipelines: tutorials/pipelines/connectingCiPipelines.md
- Rolling back deployments: tutorials/pipelines/rollback-deployments.md
- Deploy tutorials:
- Deploy a sample app to Kubernetes: tutorials/pipelines/deploy-to-kubernetes.md
- runSh tutorials:
- Using integrations with runSh: tutorials/pipelines/runShUseIntegrations.md
- Updating resource version: tutorials/pipelines/updateResourceVersion.md
- Extracting resource version information: tutorials/pipelines/extractVersionInformation.md
- Persisting state between runs: tutorials/pipelines/persistStateBetweenRuns.md
- Search: search.md