Commit Graph

103 Commits

Author SHA1 Message Date
Andy Mention 4be043a5a1
Update Ruby basics to clearly state prerequisites (#881)
These are already covered in the quickstart, but as long as the
prerequisites are mentioned here, they should probably include both
necessary libraries instead of just one.

This commit also fixes two somewhat confusing typos at the end of the
sentence.
2022-04-06 13:31:37 -07:00
Nontawat Numor eaff59f00f
Update quickstart in python 🍵 (#959)
I've already updated this example code to prevent confusion.

Follow with this section e122c64000/examples/python/helloworld/greeter_client.py (L29)
2022-03-30 11:19:53 -07:00
Patrice Chalin b4656bd108
Examples: add --shallow-submodules to clone command (#956)
* Examples: add  --shallow-submodules to clone command
* Use same URL format across languages
2022-03-23 14:01:51 -04:00
Patrice Chalin 9abb2823db
Quickstart, basic: add --depth 1 to clone command (#954) 2022-03-23 13:38:23 -04:00
Jan Tattermusch 70283ed868
c#: Remove mention of "classic" .csproj example (#952) 2022-03-16 16:59:52 +01:00
coding is so funny 8f2378a667
rename RegisterAsyncService to RegisterService (#891)
Fix grpc issue [#22884](https://github.com/grpc/grpc/issues/22884)
2022-02-16 11:25:38 -08:00
vitsensei 691a46a41d
Update C++ quickstart.md (#919) 2022-02-03 07:26:46 -08:00
Patrice Chalin 3689485b5d
Go quickstart: make code excerpt reflect latest code changes (#927) 2022-01-19 04:05:21 -05:00
Gökhan Özeloğlu 91c813581e
Fix command flag bug in document (#915)
* Fix command flag bug in document

Signed-off-by: Gökhan Özeloğlu <gozeloglu@gmail.com>

* Update Go to v1.43.0

Closes #926

Co-authored-by: Patrice Chalin <pchalin@gmail.com>
2022-01-18 15:11:17 -05:00
Jovan Arizanov 197ea0f448
Fix PHP quick start typo (#916)
fix a typo
2022-01-04 15:05:20 -08:00
Sergii Tkachenko b1642c4ac6
Update deprecated "Performance benchmark" link on "Go" page (#879)
* Update deprecated "Performance benchmark" link on "Go" page

Fixes #877

* Update _index.md
2021-10-06 15:59:21 -07:00
Esun Kim 9ecae0225f
removed abseil-installation (#870) 2021-09-22 22:15:57 -07:00
Patrice Chalin 70f7a45a21
Use manualLinkTarget for API and Daily-builds (#859) 2021-09-18 08:16:30 -04:00
Patrice Chalin c2bde91147
Don't generate API-placeholder pages (#858) 2021-09-17 20:37:26 -04:00
lebedevsergey 20fffd5f91
fix bidirectional streaming PHP example (#834) 2021-09-01 11:06:29 -07:00
Patrice Chalin 1a0dd75f58
Java codegen: link directly to Android page (#837) 2021-08-21 12:53:47 -04:00
Patrice Chalin 88d84d6536
Trim trailing whitespace from descriptions (#822) 2021-08-11 07:00:27 -04:00
Patrice Chalin 78a4d993c1
Replace use of short_title with linkTitle in page front matter (#821) 2021-08-11 06:50:38 -04:00
Patrice Chalin 6dab4c8e39
Language & platform landing page cleanup (#818) 2021-08-11 06:21:45 -04:00
Andrey Bokhanko 873ac8418b
Fix a typo in Go basics page (#800)
Fix a typo -- there is no Read() call, as the document says
2021-07-12 16:01:29 -04:00
mori yuta 9d6d806486
Go quick start: use go install (#708)
* add plugins install method go1.16

Related Issues #682

* fix text

* remove blank

* Drop patch numbers

Co-authored-by: Patrice Chalin <chalin@users.noreply.github.com>
2021-05-10 16:32:46 -04:00
Patrice Chalin 78450e5dc3
Add maintenance-mode banner to C# pages (#769) 2021-05-03 21:08:10 +02:00
Patrice Chalin 9627f20ebb
PHP quick start: replace outdated installation instructions with link (#758) 2021-04-30 15:35:36 -04:00
Planutim 39226a8d96
C# Basics tutorial: code excerpt updates (#760) 2021-04-27 10:19:50 -04:00
Patrice Chalin 3db99a7d43
Dart basics: use "dart pub" (#757) 2021-04-22 08:58:49 -04:00
Patrice Chalin 01a64c49ba
Dart 2.12+ is required (#756) 2021-04-22 08:55:42 -04:00
Abhishek Ghaskata 91ba3e27b2
Dart quick start: use "dart pub" (#755) 2021-04-22 08:43:47 -04:00
Patrice Chalin fec9490bc4
C++ quick start PATH tweaks (#754) 2021-04-21 09:09:20 -04:00
Esun Kim bb431eec25
C++ Basics: use cmake (#753) 2021-04-21 08:54:07 -04:00
Esun Kim 2c7170b847
Add abseil installation to C++ doc (#752) 2021-04-20 13:32:06 -04:00
信鑫-King 63dab091b4
Update node Quick start (#750) 2021-04-19 12:55:56 -04:00
Steve Siano e55f596f83
Fixed a typo (#747) 2021-04-13 06:47:44 -04:00
Yash Tibrewal 833dcb0725
C++ ALTS: s/grpc_impl/grpc (#737) 2021-03-24 15:17:56 -04:00
Patrice Chalin 9b21a156a2
PHP language-home: use new layout & link to examples (#734) 2021-03-22 13:04:50 -04:00
Patrice Chalin 4e5a975ccb
Don't generate daily-build placeholder pages (#732) 2021-03-22 12:05:26 -04:00
Patrice Chalin 587657c7d7
Add Kotlin gRPC case studies (#721) 2021-03-11 16:29:37 -05:00
Patrice Chalin 7e74a3e079
Kotlin landing page: add Kotlin Slack info (#714) 2021-03-10 08:00:22 -05:00
Patrice Chalin d18bd016de
Kotlin pages: drop /JVM qualifier (#712) 2021-03-09 16:50:58 -05:00
Patrice Chalin e29b23d1e4
C++ quick start: add note about local installs (#691)
Closes #690
2021-03-01 14:51:54 -05:00
Patrice Chalin a531845af9
C++ quick start: consolidate grpc build instructions (#686) 2021-03-01 11:31:55 -05:00
Daren McCulley 6cdac4cee8
Node basics: replace deprecated method (#676) 2021-02-26 11:03:32 -05:00
Patrice Chalin 5acebdf002
Update PHP's grpc_php_plugin build instructions (#684)
Closes #664
2021-02-25 15:08:24 -05:00
KITAGAWA Yasutaka fa46cd849d
Change the message type name (#665)
The type of return message of `CloseAndRecv` can be different from the parameter type of `Send`.
2021-02-23 10:37:09 -05:00
Patrice Chalin 4d859cf2ea
Add robots.txt (#652) 2021-02-16 10:06:00 -05:00
Patrice Chalin ae46bb1818
Alert shortcodes: treat all bodies as markdown (#640)
Contributes to #623
2021-02-10 11:10:12 -05:00
Patrice Chalin 0c71293fa6
PHP quickstart: use https to fetch go-pear.phar (#621)
Supersedes #560 and closes #560
2021-02-03 10:23:13 -05:00
Patrice Chalin 05fc7bf471
C++ async tutorial: fix link to basics, switch to using relref (#616) 2021-01-28 16:21:49 -05:00
Michael Lumish cb721320df
Update Node quickstart and tutorial to use grpc-js (#500) 2021-01-14 10:54:08 -05:00
Aidan Ranney c00e9fc283
Address fixes and add meta (GitHub) links to pages (#578)
* Fixup to make comment consistent with others

* Replace missing FA icon with equivalent

* Render SVGs with Markdown and restore alt text to an image

* Give used-by user logos equal padding

* Fix border radius on search inputs

* Add meta links to all pages

* Fix overflow issue from covering link's content box

* Fix spacing issue on icon links in production
2020-12-18 20:04:43 -05:00
Aidan Ranney 8e4f008bb5
Add new shortcode to add missing headings to ToC (#577)
Previously, the Markdown renderer was not being passed the headings to
render on "language home" list pages. This moves some of the template
logic into a shortcode and specifies that it should be rendered as
Markdown. The shortcode is then called directly in the index pages.
2020-12-18 12:17:10 -05:00
Patrice Chalin 877b035d32
Make page titles unique: reorder title parts (#569)
* Make page titles unique: reorder title parts

- Final work towards #363
- Contributes to #362

* Cleanup/shorten ALTS page titles

* More title cleanup

* Python generated-code page tweak
2020-12-17 09:44:50 -05:00
Patrice Chalin 043713001a
Minor cleanup following first docsy PR (#568) 2020-12-17 02:37:06 -05:00
Aidan Ranney fe231325fb
Implement the Docsy theme (#561)
* Enable Docsy theme

* Set config params for use with Docsy theme

* Remove layout files which directly conflict with Docsy theme

* Add overriding blog content template

This template overrides the default Docsy file - it accounts for
multiple authors, as well as authors containing attributes. By default,
in Docsy the post's 'author' parameter is a string containing the
author's name.

* Update docs subsection layout with Docsy markup

* Add custom sidebar-nav with icons for external links

* Add hooks partials as per Docsy guidelines

Docsy provides `head-end.html` and `body-end.html` as entry-points to
extending these areas of the theme. Existing partials for applicable
scripts and stylesheets have been migrated to these new partials.

* Add theme style variables override file

* Remove Algolia DocSearch styles and script

* Enable Google search with placeholder engine

* Add optimized header logo to Docsy header

* Add shortcode for building 'Used By' logos

* Implement home page

Refactors hompage to make the switch over from Bulma to Bootstrap.
This also entails reworking some of the shortcodes, and using Docsy's
built-in features wherever possible, such as the blocks/cover shortcode.

* Disable alternate layout for root language pages in docs

* Render auth_alts pages with shortcode instead of custom layout

* Use CSS to set background on cover blocks

* Implement 'about' page

Adds content file and shortcodes as needed to implement the 'About' page
using the Docsy theme using Docsy shortcodes.

* Implement 'showcase' page

Adds content file and shortcodes as needed to implement the 'Showcase'
page using the Docsy theme using Docsy shortcodes.

* Implement 'community' page

Adds content file and shortcodes as needed to implement the 'Community'
page using the Docsy theme using Docsy shortcodes.

* Override Docsy's list community layout

Docsy has a default 'list.html' layout file, which is opinionated about
the opening copy and block structure of this page.

* Import new site stylesheet into overridden main imports

* Apply external link icon styles

* Size homepage logo responsively

* Hide root /docs leaf pages from sidebar nav

* Move FAQ to the /docs/what_is_grpc section

* Add new in-page TOC for large screens and down

This overrides the default Docsy 'baseof' for the docs section, as well
as a new partial and styles to wrap the default table of contents in an
expandable menu.

* Clean up docs index pages for basic list layout

* Implement 'alert' Docsy shortcode in content

Docsy has a single shortcode for handling the type of functionality that
several shortcodes are currently. Whether the Docsy 'alert' shortcode is
further customized later or not, this change will allow several files to
be replaced with one.

* Replace Reddit with Google Group link in footer

* Override list page layout for the docs section

This new override is in place to account for custom frontmatter params.
Currently, the index pages for individual programming languages are
given a custom layout.

* Replace alt layout with flag for language indexes

This replaces the use of an alternate layout file for programming
language home pages with a flag that can lean on the newly overidden
'docs/list.html' template file.

* Add comments to site-specific stylesheet

* Disable Docsy overrides of default Bootstrap buttons

* Add new shortcode for rendering ToC on main pages

* Override Docsy secondary color with 'gRPC blue'

* Hide subsection list on Overview page

* Override Hugo sitemap and hide legacy pages on it

The 'quickstart' and 'tutorials' pages under the root /docs folder are
to be left, but hidden from in-page navigation and indexing. This uses
the example-site Docsy sitemap.xml file to override the default Hugo
one. A frontmatter param of 'private' is used as a flag to hide the page
from the sitemap.

* Remove unused layout, partials and shortcodes

* Disable ToC on language list pages

* Translate image rendering from Bulma to Bootstrap

* Add bannner partial to main page templates

This refactors the optional banner set in the site config from Bulma to
a custom class. In order to include the partial in the base site
structure, the default 'baseof' layout file has been overriden.

* Override breadcrumb partial to display on mobile as well

* Override Docsy CSS partial with diffs from old CSS partial

* Extract language home page content to partial

* Refactor 404 page to use Docsy-like structure and classes

* Translate buttons shortcode from Bulma to Bootstrap

* Refactor contribute page to have same structure as the other standalone pages

* Fix overflow issue with docs content on small mobile screens

* Fix user logo height on 'about' page

* Apply base and responsive styling to homepage images

* Support short titles for side nav and breadcrumbs

This change makes a check for a frontmatter param for shortened titles
while building links. It also revises the name of the param from the
existing "short" to "short_title".

* Enable "simple" view of languages index page

Frontmatter param of "simple_list" is provided by Docsy

* Remove javascript partial no longer required

As Alpine is no longer in use to trigger modals and the anchor tag
offset has been generated by Docsy, the JavaScript partial can be
removed.

* Revert auto-format changes

* Give same max-width to main content as container

In the docs section and the blog, the max-width is defined by Docsy as
80%. This intentionally caps that value at the same max-width defined by
the 'container' used elsewhere for very large screens.

* Remove list bullets and increase spacing on prog-lang-home pages

* Add redirect rule for FAQ page

* Specify 'main' branch when building meta links

The gRPC repo has updated its "master" branch to the gaining-acceptance
"main" naming.

* Enable multi-language support on site

This sets up a folder structure and configuration to enable future work
to add multiple languages to the site. To add another language, create
content under an approprite content/ subdirectory and add the key to the
'languages' param in config. As soon as a second language is added, a
dropdown menu will be generated in the Docsy top nav to select the
language.

* Revert git command in netlfy build steps

* Give supported language pages custom titles

Since this is overriding Docsy's "head" partial, the ranging over the
default "alternative output formats" and creating broken links has been
commented out of the partial as well.

* Revert "Revert git command in netlfy build steps"

This reverts commit 60a6fc076f.

* Disable Docsy buttons using variable override

* Remove deprecation warning on use of '.Dir'
2020-12-17 02:13:50 -05:00