Skip to content
This repository has been archived by the owner on Feb 28, 2023. It is now read-only.

feat(ruby): display friendly api name before page title for Ruby docs #367

Merged
merged 19 commits into from
Apr 27, 2022
Merged

feat(ruby): display friendly api name before page title for Ruby docs #367

Show file tree
Hide file tree
Changes from 9 commits
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
99f2b83
feat(ruby): add friendly api name to page title
dansaadati Apr 1, 2022
914c36b
feat(ruby): add friendly api name to page title
dansaadati Apr 1, 2022
8fb693a
Merge branch 'title-with-friendly-api-name' of https://github.com/goo…
dansaadati Apr 5, 2022
481a153
Merge branch 'title-with-friendly-api-name' of https://github.com/goo…
dansaadati Apr 5, 2022
a11becb
Merge branch 'title-with-friendly-api-name' of https://github.com/goo…
dansaadati Apr 5, 2022
daa5d46
chore(deps): update dependency click and black together (#365)
dandhlee Mar 29, 2022
709c853
chore(deps): update dependency protobuf to ~=3.20.0 (#366)
renovate-bot Apr 1, 2022
d7470a6
feat(ruby): add friendly api name to page title
renovate-bot Apr 1, 2022
c77894a
Merge branch 'main' into title-with-friendly-api-name
dandhlee Apr 7, 2022
8181f80
chore(deps): update dependency google-cloud-core to ~=2.3.0 (#371)
renovate-bot Apr 11, 2022
da85678
fix: determine title in preprocessor instead of partial template (#370)
dansaadati Apr 12, 2022
044183e
chore(deps): update dependency google-cloud-storage to ~=2.3.0 (#372)
renovate-bot Apr 13, 2022
1746065
feat(ruby): add friendly api name to page title
dansaadati Apr 1, 2022
f4446c5
feat(ruby): add friendly api name to page title
dansaadati Apr 1, 2022
45a7ad7
feat(ruby): add friendly api name to page title
renovate-bot Apr 1, 2022
21defef
fix: update goldens to match newline remove on </h1>
dansaadati Apr 13, 2022
205c633
Merge branch 'main' into title-with-friendly-api-name
dansaadati Apr 13, 2022
0431dc1
fix: remove extra line in template
dansaadati Apr 13, 2022
5d2738a
Merge branch 'main' into title-with-friendly-api-name
dansaadati Apr 27, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
4 changes: 3 additions & 1 deletion testdata/goldens/go/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,9 @@
{% verbatim %}
<div>
<article data-uid="cloud.google.com/go/storage">
<h1 class="page-title">Package cloud.google.com/go/storage
<h1 class="page-title">
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Any way we can avoid these whitespace changes? This would modify every file. Would be nice not to. Fine if not.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, if we keep it all in one line in the template, but it's slightly less readable:

<h1 class="page-title">{{#friendlyApiName}}{{friendlyApiName}} - {{/friendlyApiName}}{{#title}}{{title}}{{/title}}{{^title}}{{>partials/title}}{{/title}}</h1>

Wdyt?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That is pretty intense to read. So, let's leave it as-is.

Package cloud.google.com/go/storage

</h1>

<aside class="beta">
Expand Down
4 changes: 3 additions & 1 deletion testdata/goldens/nodejs/google.cloud.scheduler.v1.appenginehttptarget.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,9 @@
{% verbatim %}
<div>
<article data-uid="@google-cloud/scheduler!google.cloud.scheduler.v1.AppEngineHttpTarget:class">
<h1 class="page-title">Class google.cloud.scheduler.v1.AppEngineHttpTarget
<h1 class="page-title">
Class google.cloud.scheduler.v1.AppEngineHttpTarget

</h1>


Expand Down
4 changes: 3 additions & 1 deletion testdata/goldens/nodejs/google.cloud.scheduler.v1.appenginerouting.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,9 @@
{% verbatim %}
<div>
<article data-uid="@google-cloud/scheduler!google.cloud.scheduler.v1.AppEngineRouting:class">
<h1 class="page-title">Class google.cloud.scheduler.v1.AppEngineRouting
<h1 class="page-title">
Class google.cloud.scheduler.v1.AppEngineRouting

</h1>


Expand Down
4 changes: 3 additions & 1 deletion testdata/goldens/nodejs/google.cloud.scheduler.v1.cloudscheduler-class.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,9 @@
{% verbatim %}
<div>
<article data-uid="@google-cloud/scheduler!google.cloud.scheduler.v1.CloudScheduler:class">
<h1 class="page-title">Class google.cloud.scheduler.v1.CloudScheduler
<h1 class="page-title">
Class google.cloud.scheduler.v1.CloudScheduler

</h1>


Expand Down
4 changes: 3 additions & 1 deletion testdata/goldens/nodejs/google.cloud.scheduler.v1.createjobrequest.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,9 @@
{% verbatim %}
<div>
<article data-uid="@google-cloud/scheduler!google.cloud.scheduler.v1.CreateJobRequest:class">
<h1 class="page-title">Class google.cloud.scheduler.v1.CreateJobRequest
<h1 class="page-title">
Class google.cloud.scheduler.v1.CreateJobRequest

</h1>


Expand Down
4 changes: 3 additions & 1 deletion testdata/goldens/nodejs/google.cloud.scheduler.v1.deletejobrequest.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,9 @@
{% verbatim %}
<div>
<article data-uid="@google-cloud/scheduler!google.cloud.scheduler.v1.DeleteJobRequest:class">
<h1 class="page-title">Class google.cloud.scheduler.v1.DeleteJobRequest
<h1 class="page-title">
Class google.cloud.scheduler.v1.DeleteJobRequest

</h1>


Expand Down
4 changes: 3 additions & 1 deletion testdata/goldens/nodejs/google.cloud.scheduler.v1.getjobrequest.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,9 @@
{% verbatim %}
<div>
<article data-uid="@google-cloud/scheduler!google.cloud.scheduler.v1.GetJobRequest:class">
<h1 class="page-title">Class google.cloud.scheduler.v1.GetJobRequest
<h1 class="page-title">
Class google.cloud.scheduler.v1.GetJobRequest

</h1>


Expand Down
4 changes: 3 additions & 1 deletion testdata/goldens/nodejs/google.cloud.scheduler.v1.httpmethod.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,9 @@
{% verbatim %}
<div>
<article data-uid="@google-cloud/scheduler!google.cloud.scheduler.v1.HttpMethod:enum">
<h1 class="page-title">Enum google.cloud.scheduler.v1.HttpMethod
<h1 class="page-title">
Enum google.cloud.scheduler.v1.HttpMethod

</h1>


Expand Down
4 changes: 3 additions & 1 deletion testdata/goldens/nodejs/google.cloud.scheduler.v1.httptarget.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,9 @@
{% verbatim %}
<div>
<article data-uid="@google-cloud/scheduler!google.cloud.scheduler.v1.HttpTarget:class">
<h1 class="page-title">Class google.cloud.scheduler.v1.HttpTarget
<h1 class="page-title">
Class google.cloud.scheduler.v1.HttpTarget

</h1>


Expand Down
4 changes: 3 additions & 1 deletion testdata/goldens/nodejs/google.cloud.scheduler.v1.iappenginehttptarget.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,9 @@
{% verbatim %}
<div>
<article data-uid="@google-cloud/scheduler!google.cloud.scheduler.v1.IAppEngineHttpTarget:interface">
<h1 class="page-title">Interface google.cloud.scheduler.v1.IAppEngineHttpTarget
<h1 class="page-title">
Interface google.cloud.scheduler.v1.IAppEngineHttpTarget

</h1>


Expand Down
4 changes: 3 additions & 1 deletion testdata/goldens/nodejs/google.cloud.scheduler.v1.iappenginerouting.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,9 @@
{% verbatim %}
<div>
<article data-uid="@google-cloud/scheduler!google.cloud.scheduler.v1.IAppEngineRouting:interface">
<h1 class="page-title">Interface google.cloud.scheduler.v1.IAppEngineRouting
<h1 class="page-title">
Interface google.cloud.scheduler.v1.IAppEngineRouting

</h1>


Expand Down
4 changes: 3 additions & 1 deletion testdata/goldens/nodejs/google.cloud.scheduler.v1.icreatejobrequest.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,9 @@
{% verbatim %}
<div>
<article data-uid="@google-cloud/scheduler!google.cloud.scheduler.v1.ICreateJobRequest:interface">
<h1 class="page-title">Interface google.cloud.scheduler.v1.ICreateJobRequest
<h1 class="page-title">
Interface google.cloud.scheduler.v1.ICreateJobRequest

</h1>


Expand Down
4 changes: 3 additions & 1 deletion testdata/goldens/nodejs/google.cloud.scheduler.v1.ideletejobrequest.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,9 @@
{% verbatim %}
<div>
<article data-uid="@google-cloud/scheduler!google.cloud.scheduler.v1.IDeleteJobRequest:interface">
<h1 class="page-title">Interface google.cloud.scheduler.v1.IDeleteJobRequest
<h1 class="page-title">
Interface google.cloud.scheduler.v1.IDeleteJobRequest

</h1>


Expand Down
4 changes: 3 additions & 1 deletion testdata/goldens/nodejs/google.cloud.scheduler.v1.igetjobrequest.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,9 @@
{% verbatim %}
<div>
<article data-uid="@google-cloud/scheduler!google.cloud.scheduler.v1.IGetJobRequest:interface">
<h1 class="page-title">Interface google.cloud.scheduler.v1.IGetJobRequest
<h1 class="page-title">
Interface google.cloud.scheduler.v1.IGetJobRequest

</h1>


Expand Down
4 changes: 3 additions & 1 deletion testdata/goldens/nodejs/google.cloud.scheduler.v1.ihttptarget.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,9 @@
{% verbatim %}
<div>
<article data-uid="@google-cloud/scheduler!google.cloud.scheduler.v1.IHttpTarget:interface">
<h1 class="page-title">Interface google.cloud.scheduler.v1.IHttpTarget
<h1 class="page-title">
Interface google.cloud.scheduler.v1.IHttpTarget

</h1>


Expand Down
4 changes: 3 additions & 1 deletion testdata/goldens/nodejs/google.cloud.scheduler.v1.ijob.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,9 @@
{% verbatim %}
<div>
<article data-uid="@google-cloud/scheduler!google.cloud.scheduler.v1.IJob:interface">
<h1 class="page-title">Interface google.cloud.scheduler.v1.IJob
<h1 class="page-title">
Interface google.cloud.scheduler.v1.IJob

</h1>


Expand Down
4 changes: 3 additions & 1 deletion testdata/goldens/nodejs/google.cloud.scheduler.v1.ilistjobsrequest.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,9 @@
{% verbatim %}
<div>
<article data-uid="@google-cloud/scheduler!google.cloud.scheduler.v1.IListJobsRequest:interface">
<h1 class="page-title">Interface google.cloud.scheduler.v1.IListJobsRequest
<h1 class="page-title">
Interface google.cloud.scheduler.v1.IListJobsRequest

</h1>


Expand Down
4 changes: 3 additions & 1 deletion testdata/goldens/nodejs/google.cloud.scheduler.v1.ilistjobsresponse.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,9 @@
{% verbatim %}
<div>
<article data-uid="@google-cloud/scheduler!google.cloud.scheduler.v1.IListJobsResponse:interface">
<h1 class="page-title">Interface google.cloud.scheduler.v1.IListJobsResponse
<h1 class="page-title">
Interface google.cloud.scheduler.v1.IListJobsResponse

</h1>


Expand Down
4 changes: 3 additions & 1 deletion testdata/goldens/nodejs/google.cloud.scheduler.v1.ioauthtoken.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,9 @@
{% verbatim %}
<div>
<article data-uid="@google-cloud/scheduler!google.cloud.scheduler.v1.IOAuthToken:interface">
<h1 class="page-title">Interface google.cloud.scheduler.v1.IOAuthToken
<h1 class="page-title">
Interface google.cloud.scheduler.v1.IOAuthToken

</h1>


Expand Down
4 changes: 3 additions & 1 deletion testdata/goldens/nodejs/google.cloud.scheduler.v1.ioidctoken.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,9 @@
{% verbatim %}
<div>
<article data-uid="@google-cloud/scheduler!google.cloud.scheduler.v1.IOidcToken:interface">
<h1 class="page-title">Interface google.cloud.scheduler.v1.IOidcToken
<h1 class="page-title">
Interface google.cloud.scheduler.v1.IOidcToken

</h1>


Expand Down
4 changes: 3 additions & 1 deletion testdata/goldens/nodejs/google.cloud.scheduler.v1.ipausejobrequest.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,9 @@
{% verbatim %}
<div>
<article data-uid="@google-cloud/scheduler!google.cloud.scheduler.v1.IPauseJobRequest:interface">
<h1 class="page-title">Interface google.cloud.scheduler.v1.IPauseJobRequest
<h1 class="page-title">
Interface google.cloud.scheduler.v1.IPauseJobRequest

</h1>


Expand Down
4 changes: 3 additions & 1 deletion testdata/goldens/nodejs/google.cloud.scheduler.v1.ipubsubtarget.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,9 @@
{% verbatim %}
<div>
<article data-uid="@google-cloud/scheduler!google.cloud.scheduler.v1.IPubsubTarget:interface">
<h1 class="page-title">Interface google.cloud.scheduler.v1.IPubsubTarget
<h1 class="page-title">
Interface google.cloud.scheduler.v1.IPubsubTarget

</h1>


Expand Down
4 changes: 3 additions & 1 deletion testdata/goldens/nodejs/google.cloud.scheduler.v1.iresumejobrequest.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,9 @@
{% verbatim %}
<div>
<article data-uid="@google-cloud/scheduler!google.cloud.scheduler.v1.IResumeJobRequest:interface">
<h1 class="page-title">Interface google.cloud.scheduler.v1.IResumeJobRequest
<h1 class="page-title">
Interface google.cloud.scheduler.v1.IResumeJobRequest

</h1>


Expand Down
4 changes: 3 additions & 1 deletion testdata/goldens/nodejs/google.cloud.scheduler.v1.iretryconfig.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,9 @@
{% verbatim %}
<div>
<article data-uid="@google-cloud/scheduler!google.cloud.scheduler.v1.IRetryConfig:interface">
<h1 class="page-title">Interface google.cloud.scheduler.v1.IRetryConfig
<h1 class="page-title">
Interface google.cloud.scheduler.v1.IRetryConfig

</h1>


Expand Down
4 changes: 3 additions & 1 deletion testdata/goldens/nodejs/google.cloud.scheduler.v1.irunjobrequest.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,9 @@
{% verbatim %}
<div>
<article data-uid="@google-cloud/scheduler!google.cloud.scheduler.v1.IRunJobRequest:interface">
<h1 class="page-title">Interface google.cloud.scheduler.v1.IRunJobRequest
<h1 class="page-title">
Interface google.cloud.scheduler.v1.IRunJobRequest

</h1>


Expand Down
4 changes: 3 additions & 1 deletion testdata/goldens/nodejs/google.cloud.scheduler.v1.iupdatejobrequest.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,9 @@
{% verbatim %}
<div>
<article data-uid="@google-cloud/scheduler!google.cloud.scheduler.v1.IUpdateJobRequest:interface">
<h1 class="page-title">Interface google.cloud.scheduler.v1.IUpdateJobRequest
<h1 class="page-title">
Interface google.cloud.scheduler.v1.IUpdateJobRequest

</h1>


Expand Down
4 changes: 3 additions & 1 deletion testdata/goldens/nodejs/google.cloud.scheduler.v1.job-class.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,9 @@
{% verbatim %}
<div>
<article data-uid="@google-cloud/scheduler!google.cloud.scheduler.v1.Job:class">
<h1 class="page-title">Class google.cloud.scheduler.v1.Job
<h1 class="page-title">
Class google.cloud.scheduler.v1.Job

</h1>


Expand Down
4 changes: 3 additions & 1 deletion testdata/goldens/nodejs/google.cloud.scheduler.v1.job.state.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,9 @@
{% verbatim %}
<div>
<article data-uid="@google-cloud/scheduler!google.cloud.scheduler.v1.Job.State:enum">
<h1 class="page-title">Enum google.cloud.scheduler.v1.Job.State
<h1 class="page-title">
Enum google.cloud.scheduler.v1.Job.State

</h1>


Expand Down
4 changes: 3 additions & 1 deletion testdata/goldens/nodejs/google.cloud.scheduler.v1.listjobsrequest.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,9 @@
{% verbatim %}
<div>
<article data-uid="@google-cloud/scheduler!google.cloud.scheduler.v1.ListJobsRequest:class">
<h1 class="page-title">Class google.cloud.scheduler.v1.ListJobsRequest
<h1 class="page-title">
Class google.cloud.scheduler.v1.ListJobsRequest

</h1>


Expand Down
4 changes: 3 additions & 1 deletion testdata/goldens/nodejs/google.cloud.scheduler.v1.listjobsresponse.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,9 @@
{% verbatim %}
<div>
<article data-uid="@google-cloud/scheduler!google.cloud.scheduler.v1.ListJobsResponse:class">
<h1 class="page-title">Class google.cloud.scheduler.v1.ListJobsResponse
<h1 class="page-title">
Class google.cloud.scheduler.v1.ListJobsResponse

</h1>


Expand Down
4 changes: 3 additions & 1 deletion testdata/goldens/nodejs/google.cloud.scheduler.v1.oauthtoken.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,9 @@
{% verbatim %}
<div>
<article data-uid="@google-cloud/scheduler!google.cloud.scheduler.v1.OAuthToken:class">
<h1 class="page-title">Class google.cloud.scheduler.v1.OAuthToken
<h1 class="page-title">
Class google.cloud.scheduler.v1.OAuthToken

</h1>


Expand Down
4 changes: 3 additions & 1 deletion testdata/goldens/nodejs/google.cloud.scheduler.v1.oidctoken.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,9 @@
{% verbatim %}
<div>
<article data-uid="@google-cloud/scheduler!google.cloud.scheduler.v1.OidcToken:class">
<h1 class="page-title">Class google.cloud.scheduler.v1.OidcToken
<h1 class="page-title">
Class google.cloud.scheduler.v1.OidcToken

</h1>


Expand Down
4 changes: 3 additions & 1 deletion testdata/goldens/nodejs/google.cloud.scheduler.v1.pausejobrequest.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,9 @@
{% verbatim %}
<div>
<article data-uid="@google-cloud/scheduler!google.cloud.scheduler.v1.PauseJobRequest:class">
<h1 class="page-title">Class google.cloud.scheduler.v1.PauseJobRequest
<h1 class="page-title">
Class google.cloud.scheduler.v1.PauseJobRequest

</h1>


Expand Down
4 changes: 3 additions & 1 deletion testdata/goldens/nodejs/google.cloud.scheduler.v1.pubsubtarget.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,9 @@
{% verbatim %}
<div>
<article data-uid="@google-cloud/scheduler!google.cloud.scheduler.v1.PubsubTarget:class">
<h1 class="page-title">Class google.cloud.scheduler.v1.PubsubTarget
<h1 class="page-title">
Class google.cloud.scheduler.v1.PubsubTarget

</h1>


Expand Down
4 changes: 3 additions & 1 deletion testdata/goldens/nodejs/google.cloud.scheduler.v1.resumejobrequest.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,9 @@
{% verbatim %}
<div>
<article data-uid="@google-cloud/scheduler!google.cloud.scheduler.v1.ResumeJobRequest:class">
<h1 class="page-title">Class google.cloud.scheduler.v1.ResumeJobRequest
<h1 class="page-title">
Class google.cloud.scheduler.v1.ResumeJobRequest

</h1>


Expand Down
4 changes: 3 additions & 1 deletion testdata/goldens/nodejs/google.cloud.scheduler.v1.retryconfig.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,9 @@
{% verbatim %}
<div>
<article data-uid="@google-cloud/scheduler!google.cloud.scheduler.v1.RetryConfig:class">
<h1 class="page-title">Class google.cloud.scheduler.v1.RetryConfig
<h1 class="page-title">
Class google.cloud.scheduler.v1.RetryConfig

</h1>


Expand Down
Loading