Skip to content

docs - #169

Merged
silvolu merged 8 commits into
googleapis:masterfrom
stephenplusplus:site
Sep 4, 2014
Merged

docs#169
silvolu merged 8 commits into
googleapis:masterfrom
stephenplusplus:site

Conversation

@stephenplusplus

@stephenplusplusstephenplusplus commented Sep 3, 2014

Copy link
Copy Markdown
Contributor

This should be interesting.

Here's the new structure: https://github.com/stephenplusplus/gcloud-node/tree/site/docs

Assuming all works well, Travis will run our new docs process, which uses dox. This takes the JSdoc and spits out JSON, that is then transformed to match our new template.

@ryanseys

ryanseys commented Sep 3, 2014

Copy link
Copy Markdown
Contributor

New template?

@stephenplusplus

stephenplusplus commented Sep 3, 2014

Copy link
Copy Markdown
ContributorAuthor

Yep, updated the post with a little more info.

@silvolu

silvolu commented Sep 3, 2014

Copy link
Copy Markdown
Contributor

@stephenplusplus can you remove the language selector for now? After that I'll merge and then we'll iterate on it.

@silvolu

silvolu commented Sep 3, 2014

Copy link
Copy Markdown
Contributor

Also I've just noticed that a lot of the links in the reference docs are not working, e.g.:
http://googlecloudplatform.github.io/#/docs/datastore
http://googlecloudplatform.github.io/#/docs/storage

@stephenplusplus

stephenplusplus commented Sep 3, 2014

Copy link
Copy Markdown
ContributorAuthor

Ok, thanks for catching that. The site was designed to work from /, but because of the /gcloud-node/ subdirectory we consider our "root", some areas got thrown off. Will fix.

@stephenplusplus

stephenplusplus commented Sep 3, 2014

Copy link
Copy Markdown
ContributorAuthor

Updated: http://googlecloudplatform.github.io/gcloud-node/#/

@silvolu

silvolu commented Sep 3, 2014

Copy link
Copy Markdown
Contributor

Experiencing a strange issue. If i navigate to the docs, scroll down and click on the storage link (just below Returns), the storage page is loaded, but instead of seeing the top of the page, I see the copy function.
Can you reproduce?

@stephenplusplus

stephenplusplus commented Sep 3, 2014

Copy link
Copy Markdown
ContributorAuthor

Reproduced. Fixed via this solution: http://stackoverflow.com/a/24549173/776934

stephenplusplus
stephenplusplus reviewed Sep 3, 2014
View reviewed changes
Comment threaddocs/index.html Outdated

This comment was marked as spam.

Sign in to view

@beriberikix

beriberikix commented Sep 4, 2014

Copy link
Copy Markdown
Contributor

Here are requested changes from our email conversation:

  • change the font of the code snippet, Monaco (I think Monaco is Mac-only so we'll need fallback
  • sample code: 0.8em, less padding, reduce contrast (more like overall theme)
  • add line numbers on every line

@beriberikix

beriberikix commented Sep 4, 2014

Copy link
Copy Markdown
Contributor

Also, can we add the GA snippet to every page?

<script>(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*newDate();a=s.createElement(o),m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)})(window,document,'script','//www.google-analytics.com/analytics.js','ga');ga('create','UA-49880327-13','auto');ga('send','pageview');</script>

@stephenplusplus

stephenplusplus commented Sep 4, 2014

Copy link
Copy Markdown
ContributorAuthor

change the font of the code snippet, Monaco (I think Monaco is Mac-only so we'll need fallback

I will see what I can do. 👍

sample code: 0.8em, less padding, reduce contrast (more like overall theme)

The entire code snippet style has changed, so all of the above are changed. It's using a separate plug-in, with a separate theme chosen to match GitHub colors. Can the original requester of the change take another look and see if they still feel that way?

add line numbers on every line

This request made more sense than having line numbers every 5 lines, like it was previously. But again, since this has changed, do line numbers really offer any value?

@stephenplusplus

stephenplusplus commented Sep 4, 2014

Copy link
Copy Markdown
ContributorAuthor

Also, can we add the GA snippet to every page?

#169 (comment) Just needed the id :)

@stephenplusplus

stephenplusplus commented Sep 4, 2014

Copy link
Copy Markdown
ContributorAuthor

Analytics + font changes: http://googlecloudplatform.github.io/gcloud-node/#/

@beriberikix

beriberikix commented Sep 4, 2014

Copy link
Copy Markdown
Contributor

@jgeewax for font, @rakyll for styling and line #

@ryanseys

ryanseys commented Sep 4, 2014

Copy link
Copy Markdown
Contributor

Add a favicon too to the <head>. Here's the one used by https://googlecloudplatform.github.io:

<link rel="shortcut icon" href="https://cloud.google.com/images/gcp-favicon.ico">

@rakyll

rakyll commented Sep 4, 2014

Copy link
Copy Markdown
Contributor

Sorry for not catching up with the PR earlier. It looks excellent!

@stephenplusplus

stephenplusplus commented Sep 4, 2014

Copy link
Copy Markdown
ContributorAuthor

Woo! Updates are in.

miguelvelezsa pushed a commit that referenced this pull request Jan 28, 2026
@jmdobry
Switch to individual API packages. (#169)
6f157b4
* Switch to individual API packages.
* Address comments
* Address comments
miguelvelezsa pushed a commit that referenced this pull request Jan 28, 2026
@renovate@jkwlui
chore(deps): update dependency eslint-config-prettier to v3 (#169)
1b38810
@miguelvelezsamiguelvelezsa mentioned this pull request Jan 28, 2026
Closed
@GautamShardaGautamSharda mentioned this pull request Feb 2, 2026
Closed
sofisl pushed a commit that referenced this pull request Feb 3, 2026
@jmdobry
Switch to individual API packages. (#169)
3b3f0e5
* Switch to individual API packages.
* Address comments
* Address comments
sofisl pushed a commit that referenced this pull request Feb 3, 2026
@renovate@jkwlui
chore(deps): update dependency eslint-config-prettier to v3 (#169)
23f0fdb
@sofislsofisl mentioned this pull request Feb 3, 2026
Merged
4 tasks
GautamSharda pushed a commit that referenced this pull request Feb 3, 2026
@jmdobry
Switch to individual API packages. (#169)
e404785
* Switch to individual API packages.
* Address comments
* Address comments
@GautamShardaGautamSharda mentioned this pull request Feb 3, 2026
Merged
4 tasks
sofisl pushed a commit that referenced this pull request Feb 4, 2026
@renovate@JustinBeckwith
chore(deps): update dependency typescript to ~3.1.0 (#169)
4ffe96c
This was referenced Feb 4, 2026
Closed
Closed
Merged
Closed
sofisl pushed a commit that referenced this pull request Feb 5, 2026
@jmdobry
Switch to individual API packages. (#169)
2eb2d05
* Switch to individual API packages.
* Address comments
* Address comments
sofisl pushed a commit that referenced this pull request Feb 5, 2026
@renovate@jkwlui
chore(deps): update dependency eslint-config-prettier to v3 (#169)
6e480e1
GautamSharda pushed a commit that referenced this pull request Feb 5, 2026
@renovate@JustinBeckwith
chore(deps): lock file maintenance (#169)
8eb660c
@GautamShardaGautamSharda mentioned this pull request Feb 5, 2026
Closed
4 tasks
@sofislsofisl mentioned this pull request Feb 17, 2026
Merged
4 tasks
This was referenced Feb 23, 2026
Closed
Closed
Merged
This was referenced Feb 26, 2026
Closed
Merged
@GautamShardaGautamSharda mentioned this pull request Mar 5, 2026
Merged
4 tasks
@codyosscodyoss mentioned this pull request Mar 5, 2026
Merged
@GautamShardaGautamSharda mentioned this pull request Mar 5, 2026
Merged
4 tasks
@meltsufinmeltsufin mentioned this pull request Mar 10, 2026
Merged
@GautamShardaGautamSharda mentioned this pull request Mar 12, 2026
Merged
4 tasks
@GautamShardaGautamSharda mentioned this pull request Mar 23, 2026
Merged
4 tasks
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@stephenplusplus@ryanseys@silvolu@beriberikix@rakyll