Depending on product release schedules and workflows of various authoring teams across Adobe, you might need to create additional repositories to host various types of documentation that you don’t want to include in the public documentation yet, such as Beta documentation that should only be accessible to a select number of customers.
This article explains how to create a new repository, configure a new Jenkins build job to push the content live, and finally, how to activate the new repository on experienceleague.adobe.com.
For background information, see User guide setup.
Here’s how to create a new repository:
Go to AdobeDocs GitHub and log in with your LDAP credentials.
Click New.
Enter the name of your new repository in the Repository name field.
Use the <repo-name>.en
format, such as campaign-classic.en.
Use lower-case letters and hyphens. Add the .en
suffix to allow for localization.
If you’re not sure what the name of your repo should be, log a JIRA bug (project: UGP) and assign it to Bob Bringhurst. Bob will consult with the Tech Marketing team.
Click Create repository.
Now you can clone your repository locally and start working in it. See Git Setup for details on how to clone your repository locally.
On a Mac, press Command+Shift+. to unhide system files. Copy the .gitignore
file to your new repo. Then press Command+Shift+. again to hide system files.
Edit the metadata.md and TOC.md files for the new repo. Include the following:
See Metadata and User Guide Setup for details.
Add UICONTROL
and DNL
tags for localization.
Bob (or another SCCM member) will do the following:
activate-new
list.[ ] Create repo in Corp > AdobeDocs.
hide: yes
) prior to soft-launch.[ ] Add repo (including Loc in most cases) to Airtable, with Publish=False.
[ ] Connect repo to EXL.
[ ] Make sure repo is configured properly.
[ ] Add Loc repos to Airtable, if necessary.
[ ] Add lead writer to github.com > repo with Admin access.
[ ] Add repo to activate-new
configuration.
[ ] Select Publish in Airtable (English and Loc) when ready.
[ ] Change hide: yes
to index: yes
after soft launch.
[ ] Add link to landing pages.
Go to Jenkins and log in with your LDAP credentials.
Open the GenerateExlJob job.
In the left side menu, click Build with Parameters.
Enter the root name of the repository that you created at Step 1 in the SOLUTION field.
Enter the repository language (such as en
) in the LANG field.
Click Build.
Open the exl job and make sure that it’s enabled (it should be enabled by default).
Stage is not yet available. Once it’s available, you’ll want to enable exl-stg as well to work with the staging branch.
In Git, create webhook:
https://adobedocs.ci.corp.adobe.com/github-webhook/
application/json
SSL verification ENABLE
Permissions:
Open repo and go to Settings > Hooks.
Click Add Webhook.
Specify Payload URL:
http://acrolinx-prod.corp.adobe.com:1500/listen/
http://or1010051251054.corp.adobe.com:1500/listen/
Content type = json
Specify the Shared secret for Production or QA - see Bob.
Select Let me select individual events: select Pull Requests and Pushes.
Make sure webhook is set to Active.
Click Add webhook.
Go to acrolinx-testing.en > acrolinxconfig > repositories-nil-backup.edn.
Add new repo(s) using this format.
["https://git.corp.adobe.com/api/v3/repos/AdobeDocs/acrolinx-testing.en" nil]
Last entry:
["https://git.corp.adobe.com/api/v3/repos/AdobeDocs/acrolinx-testing.en" nil]]
When creating a baseline at the beginning of the month, do the following:
<date>
.edn file.The baseline will be run later that evening. In the morning, you should see the [nil]
values replaced with data.
Whenever you edit the repositories.edn file, the changes are processed once every 24 hours (evening PT).