update titles for REST API activity docs (#49040)

syossan27 · Feb 7, 2024 · 602cc80 · 602cc80
1 parent dd8ffd3
commit 602cc80
Show file tree

Hide file tree

Showing 8 changed files with 33 additions and 21 deletions.
diff --git a/content/actions/using-workflows/events-that-trigger-workflows.md b/content/actions/using-workflows/events-that-trigger-workflows.md
@@ -1257,7 +1257,7 @@ jobs:
 
 {% data reusables.actions.branch-requirement %}
 
-Runs your workflow when the workflow's repository is starred. For information about the pull request APIs, see "[AUTOTITLE](/graphql/reference/mutations#addstar)" in the GraphQL API documentation or "[AUTOTITLE](/rest/activity#starring)" in the REST API documentation.
+Runs your workflow when the workflow's repository is starred. For information about the pull request APIs, see "[AUTOTITLE](/graphql/reference/mutations#addstar)" in the GraphQL API documentation or "[AUTOTITLE](/rest/activity#starring)."
 
 For example, you can run a workflow when someone stars a repository, which is the `started` activity type for a watch event.
 

diff --git a/content/rest/activity/events.md b/content/rest/activity/events.md
@@ -1,5 +1,7 @@
 ---
-title: Events
+title: REST API endpoints for events
+shortTitle: Events
+allowTitleToDifferFromFilename: true
 intro: >-
   Use the REST API to interact with {% data variables.product.prodname_dotcom %}
   events.

diff --git a/content/rest/activity/feeds.md b/content/rest/activity/feeds.md
@@ -1,5 +1,7 @@
 ---
-title: Feeds
+title: REST API endpoints for feeds
+shortTitle: Feeds
+allowTitleToDifferFromFilename: true
 intro: >-
   Use the REST API to interact with {% data variables.product.prodname_dotcom %}
   feeds.
@@ -33,11 +35,11 @@ HTTP/2 200
 
 ```xml
 <?xml version="1.0" encoding="UTF-8"?>
-<feed xmlns="http://www.w3.org/2005/Atom" 
-xmlns:media="http://search.yahoo.com/mrss/" 
+<feed xmlns="http://www.w3.org/2005/Atom"
+xmlns:media="http://search.yahoo.com/mrss/"
 xml:lang="en-US">
   <id>tag:github.com,2008:/security-advisories</id>
-  <link rel="self" type="application/atom+xml" 
+  <link rel="self" type="application/atom+xml"
   href="https://github.com/security-advisories.atom"/>
   <title>GitHub Security Advisory Feed</title>
   <author>
@@ -48,17 +50,17 @@ xml:lang="en-US">
       <id>tag:github.com,2008:GHSA-abcd-12ab-23cd</id>
       <published>2018-07-26T15:14:52Z</published>
       <updated>2019-01-14T19:34:52Z</updated>
-      <title type="html">[GHSA-abcd-12ab-23cd] Moderate 
+      <title type="html">[GHSA-abcd-12ab-23cd] Moderate
       severity vulnerability that affects Octoapp</title>
         <category term="NPM"/>
       <content type="html">
-        &lt;p&gt;Octoapp node module before 4.17.5 suffers 
-        from a Modification of Assumed-Immutable Data (MAID) 
-        vulnerability via defaultsDeep, merge, and mergeWith 
-        functions, which allows a malicious user to modify 
-        the prototype of &quot;Object&quot; via 
-        &lt;strong&gt;proto&lt;/strong&gt;, causing the 
-        addition or modification of an existing property 
+        &lt;p&gt;Octoapp node module before 4.17.5 suffers
+        from a Modification of Assumed-Immutable Data (MAID)
+        vulnerability via defaultsDeep, merge, and mergeWith
+        functions, which allows a malicious user to modify
+        the prototype of &quot;Object&quot; via
+        &lt;strong&gt;proto&lt;/strong&gt;, causing the
+        addition or modification of an existing property
         that will exist on all objects.&lt;/p&gt;
           &lt;p&gt;&lt;strong&gt;Affected Packages&lt;/strong&gt;&lt;/p&gt;
 

diff --git a/content/rest/activity/index.md b/content/rest/activity/index.md
@@ -1,5 +1,7 @@
 ---
-title: Activity
+title: REST API endpoints for activity
+shortTitle: Activity
+allowTitleToDifferFromFilename: true
 intro: 'Use the REST API to list events and feeds and manage notifications, starring, and watching.'
 redirect_from:
   - /v3/activity

diff --git a/content/rest/activity/notifications.md b/content/rest/activity/notifications.md
@@ -1,5 +1,7 @@
 ---
-title: Notifications
+title: REST API endpoints for notifications
+shortTitle: Notifications
+allowTitleToDifferFromFilename: true
 intro: >-
   Use the REST API to manage {% data variables.product.product_name %}
   notifications.

diff --git a/content/rest/activity/starring.md b/content/rest/activity/starring.md
@@ -1,6 +1,8 @@
 ---
-title: Starring
+title: REST API endpoints for starring
+shortTitle: Starring
 intro: Use the REST API to bookmark a repository.
+allowTitleToDifferFromFilename: true
 versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖
   fpt: '*'
   ghae: '*'
@@ -21,7 +23,7 @@ In August 2012, we [changed the way watching
 works](https://github.com/blog/1204-notifications-stars) on {% data variables.product.prodname_dotcom %}. Some API
 client applications may still be using the original "watcher" endpoints for accessing
 this data. You should now use the "star" endpoints instead (described
-below). For more information, see the REST API "[AUTOTITLE](/rest/activity/watching)" documentation and the [Watcher API changelog post](https://developer.github.com/changes/2012-09-05-watcher-api/).
+below). For more information, see "[AUTOTITLE](/rest/activity/watching)" and the [changelog post](https://developer.github.com/changes/2012-09-05-watcher-api/).
 
 In responses from the REST API, `watchers`, `watchers_count`, and `stargazers_count` correspond to the number of users that have starred a repository, whereas `subscribers_count` corresponds to the number of watchers.
 

diff --git a/content/rest/activity/watching.md b/content/rest/activity/watching.md
@@ -1,6 +1,8 @@
 ---
-title: Watching
+title: REST API endpoints for watching
+shortTitle: Watching
 intro: Use the REST API to subscribe to notifications for activity in a repository.
+allowTitleToDifferFromFilename: true
 versions: # DO NOT MANUALLY EDIT. CHANGES WILL BE OVERWRITTEN BY A 🤖
   fpt: '*'
   ghae: '*'
@@ -20,7 +22,7 @@ You can use the REST API to subscribe to notifications for activity in a reposit
 In August 2012, we [changed the way watching
 works](https://github.com/blog/1204-notifications-stars) on {% data variables.product.prodname_dotcom %}. Some API
 client applications may still be using the original "watcher" endpoints for accessing
-this data. You should now use the "star" endpoints instead. For more information, see the REST API "[AUTOTITLE](/rest/activity/starring)" documentation and the [Watcher API Change post](https://developer.github.com/changes/2012-09-05-watcher-api/).
+this data. You should now use the "star" endpoints instead. For more information, "[AUTOTITLE](/rest/activity/starring)" and the [changelog post](https://developer.github.com/changes/2012-09-05-watcher-api/).
 
 In responses from the REST API, `subscribers_count` corresponds to the number of watchers, whereas `watchers`, `watchers_count`, and `stargazers_count` correspond to the number of users that have starred a repository.
 

diff --git a/data/reusables/webhooks/watch_short_desc.md b/data/reusables/webhooks/watch_short_desc.md
@@ -1 +1 @@
-When someone stars a repository. {% data reusables.webhooks.action_type_desc %} For more information, see the "[AUTOTITLE](/rest/activity#starring)" REST API.
+When someone stars a repository. {% data reusables.webhooks.action_type_desc %} For more information, see "[AUTOTITLE](/rest/activity#starring)."
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		When someone stars a repository. {% data reusables.webhooks.action_type_desc %} For more information, see the "[AUTOTITLE](/rest/activity#starring)" REST API.
		When someone stars a repository. {% data reusables.webhooks.action_type_desc %} For more information, see "[AUTOTITLE](/rest/activity#starring)."