Skip to content

Commit e8ac523

Browse files
glaubinixnaderman
andauthored
Apply suggestions from code review
Co-authored-by: Nils Adermann <[email protected]>
1 parent a495f11 commit e8ac523

File tree

1 file changed

+16
-16
lines changed

1 file changed

+16
-16
lines changed

docs/conductor/getting-started.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,28 @@
11
# Getting started with Conductor
22
##
33

4-
Conductor will group and schedule automated dependency updates on your own Continuous Integration platform. If the update succeeds, Conductor will send you a pull request to your code hosting platform (GitHub, GitLab, Bitbucket) with the changed composer.lock file and, if necessary, other files modified by Composer plugins or scripts.
4+
Conductor will group and schedule automated dependency updates on your own continuous integration platform. If the update succeeds, Conductor will send you a pull request to your code hosting platform (GitHub, GitLab, Bitbucket) with the changed composer.lock file and, if necessary, other files modified by Composer plugins or scripts.
55

6-
To use Conductor:
6+
Prerequisites for receiving dependency update PRs from Conductor:
77

8-
- You need to be approved for early access to Conductor. [Join the waitlist](/features/conductor) and wait for approval.
9-
- You need a Private Packagist trial or subscription on the cloud plan.
10-
- You need to add a synchronization with your code hosting platform.
11-
- You need to add a workflow to your Continuous Integration platform to run Composer updates.
8+
- Receive early access to Conductor. [Join the waitlist](/features/conductor) and wait for approval.
9+
- Set up an organization on Private Packagist Cloud either with a free trial or subscribe to the cloud plan.
10+
- A synchronization in your Private Packagist organization with your code hosting platform.
11+
- A workflow on your continuous integration platform to run Composer updates.
1212

13-
## Add a synchronization
13+
## Set up synchronization
1414

1515
Once you have a Private Packagist organization and Conductor is enabled for you, log into your Private Packagist organization and head to the "Settings" tab in the main navigation.
1616
Under the "Synchronization" entry you can add [one or more synchronizations](/features/integration-github-bitbucket-gitlab.md) with an organization on your code hosting platform.
17-
This is how you grant us access to your repositories. Once done we will automatically add any repository with a composer.json file in the root directory as a package to Private Packagist.
17+
This is how you grant us access to your VCS repositories. The synchronization will automatically add any repository with a composer.json file in the root directory as a package to Private Packagist.
1818

1919
## Configure Conductor for your packages
2020

21-
Access the "Conductor" tab in the main navigation to see a list of available packages that can be managed via Conductor.
22-
Each package shown is linked to a repository where you can receive pull requests from Conductor. This usually includes all your Composer projects.
23-
Conductor will manage dependencies for packages added to Private Packagist [via synchronization](/features/integration-github-bitbucket-gitlab.md) that have a composer.lock file committed to the repository.
21+
Access the "Conductor" tab in the main navigation to see a list of available packages that can have their dependencies updated by Conductor.
22+
Each package shown is linked to its VCS repository to which Conductor will send pull requests with dependency updates. Your Composer projects or applications are also a kind of package and must be added to Private Packagist as regular packages to use Conductor on them.
23+
Conductor can only manage dependencies for packages added to Private Packagist [via synchronization](/features/integration-github-bitbucket-gitlab.md) that have a composer.lock file committed to the repository.
2424

25-
To get started, click on the configure link displayed for the package where you want to use Conductor and follow the instructions for your Continuous Integration platform.
25+
To get started, click on the configure link displayed next to the package which you would like Conductor to update. Follow the instructions for your continuous integration platform.
2626

2727
### GitHub Actions
2828

@@ -38,7 +38,7 @@ We recommend to create a dedicated authentication token with update access. You
3838

3939
![Create Authentication Token](/Resources/public/img/docs/conductor/authentication-token.png)
4040

41-
The contents of the variable should look like
41+
The contents of the variable should look like this:
4242

4343
```json
4444
{"http-basic": {"repo.packagist.com": {"username": "token", "password": "packagist_out_73a81c..." }}}
@@ -48,8 +48,8 @@ Conductor needs to verify your CI setup before you can start receiving PRs.
4848

4949
## Verify your CI setup
5050

51-
- Navigate to the "Conductor" tab in your Private Packagist organization
52-
- Click on the name of your package
51+
- Navigate to the "Conductor" tab in your Private Packagist organization.
52+
- Click on the name of your package.
5353

5454
![Task list with verification task](/Resources/public/img/docs/conductor/verification-task-list.png)
5555

@@ -86,7 +86,7 @@ If all these steps succeeded, Private Packagist creates a pull request for the n
8686
![Conductor Pull Request](https://packagist.com/img/features/auto-updates/merged-PR-for-a-security-updated.png)
8787

8888
Once you reviewed the changes and merged the PR, Conductor will schedule the next task.
89-
If you close the PR, the task will be paused and Conductor will schedule the next task. This is the same effect as using the "Pause" button in the UI. Conductor won't attempt to update the dependency to this exact version again but will schedule updates with newer versions.
89+
If you close the PR, the task will be paused and Conductor will schedule the next task. Clicking the "Pause" button in the UI has the same effect. Conductor won't attempt to update the dependency to this exact version again but it will schedule updates to newer versions.
9090

9191
If you want to schedule any other task in the list, click on its name and use the button "Schedule now to create a PR".
9292

0 commit comments

Comments
 (0)