Skip to content

Commit 457e23b

Browse files
committed
Project import generated by Copybara.
PiperOrigin-RevId: 486225475 Change-Id: Ibe171a4eca81ed94e1e60d4e65f9cad048007bc4
1 parent 36a4756 commit 457e23b

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

64 files changed

+900
-152
lines changed

CONTRIBUTING.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# How to Contribute
2+
3+
We'd love to accept your patches and contributions to this project. There are
4+
just a few small guidelines you need to follow.
5+
6+
## Contributor License Agreement
7+
8+
Contributions to this project must be accompanied by a Contributor License
9+
Agreement. You (or your employer) retain the copyright to your contribution;
10+
this simply gives us permission to use and redistribute your contributions as
11+
part of the project. Head over to <https://cla.developers.google.com/> to see
12+
your current agreements on file or to sign a new one.
13+
14+
You generally only need to submit a CLA once, so if you've already submitted one
15+
(even if it was for a different project), you probably don't need to do it
16+
again.
17+
18+
## Code Reviews
19+
20+
All submissions, including submissions by project members, require review. We
21+
use GitHub pull requests for this purpose. Consult
22+
[GitHub Help](https://help.github.com/articles/about-pull-requests/) for more
23+
information on using pull requests.
24+
25+
## Community Guidelines
26+
27+
This project follows [Google's Open Source Community
28+
Guidelines](https://opensource.google/conduct/).

README.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Protocol Buffers - Google's data interchange format
2+
3+
Copyright 2008 Google Inc.
4+
5+
https://protobuf.dev
6+
7+
## Overview
8+
9+
Protocol Buffers (a.k.a., protobuf) are Google's language-neutral,
10+
platform-neutral, extensible mechanism for serializing structured data. This
11+
site holds Protocol Buffers documentation.
12+
13+
## Protocol Buffers Repository
14+
15+
The Protocol Buffers GitHub repository is
16+
https://github.com/protocolbuffers/protobuf.
17+
18+
## Developer Community
19+
20+
To be alerted to upcoming changes in Protocol Buffers and connect with protobuf
21+
developers and users,
22+
[join the Google Group](https://groups.google.com/g/protobuf).

config.toml

Lines changed: 183 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,183 @@
1+
# baseURL = 'https://protobuf.dev'
2+
languageCode = 'en-us'
3+
title = 'Protocol Buffers Documentation'
4+
theme = ["docsy"]
5+
sidebar_search_disable = true
6+
7+
# Language settings
8+
contentDir = "content"
9+
defaultContentLanguage = "en"
10+
defaultContentLanguageInSubdir = false
11+
enableMissingTranslationPlaceholders = true
12+
enableRobotsTXT = true
13+
enableGitInfo = false
14+
15+
[taxonomies]
16+
tag = "tags"
17+
category = "categories"
18+
19+
[params.taxonomy]
20+
# set taxonomyCloud = [] to hide taxonomy clouds
21+
taxonomyCloud = ["tags", "categories"]
22+
23+
# Highlighting config
24+
pygmentsCodeFences = true
25+
pygmentsUseClasses = false
26+
# Use the new Chroma Go highlighter in Hugo.
27+
pygmentsUseClassic = false
28+
#pygmentsOptions = "linenos=table"
29+
# See https://help.farbox.com/pygments.html
30+
pygmentsStyle = "tango"
31+
32+
# Configure how URLs look like per section.
33+
[permalinks]
34+
blog = "/:section/:year/:month/:day/:slug/"
35+
36+
## Configuration for BlackFriday markdown parser: https://github.com/russross/blackfriday
37+
[blackfriday]
38+
plainIDAnchors = true
39+
hrefTargetBlank = true
40+
angledQuotes = false
41+
latexDashes = true
42+
smartypants = false
43+
44+
# Image processing configuration.
45+
[imaging]
46+
resampleFilter = "CatmullRom"
47+
quality = 75
48+
anchor = "smart"
49+
50+
[services]
51+
[services.googleAnalytics]
52+
id = "G-5L8P8GRN4Y"
53+
54+
# Language configuration
55+
56+
[languages]
57+
[languages.en]
58+
title = "Protocol Buffers Documentation"
59+
languageName ="English"
60+
# Weight used for sorting.
61+
weight = 1
62+
63+
64+
[markup]
65+
[markup.goldmark]
66+
[markup.goldmark.renderer]
67+
unsafe = true
68+
[markup.highlight]
69+
# See a complete list of available styles at https://xyproto.github.io/splash/docs/all.html
70+
style = "tango"
71+
# Uncomment if you want your chosen highlight style used for code blocks without a specified language
72+
# guessSyntax = "true"
73+
74+
# Everything below this are Site Params
75+
76+
# Comment out if you don't want the "print entire section" link enabled.
77+
[outputs]
78+
section = ["HTML", "print", "RSS"]
79+
80+
[params]
81+
description = "Protocol buffers is a language-neutral, platform-neutral extensible mechanism for serializing structured data."
82+
copyright = "Google LLC"
83+
privacy_policy = "https://policies.google.com/privacy"
84+
85+
# First one is picked as the Twitter card image if not set on page.
86+
# images = ["images/project-illustration.png"]
87+
88+
# Menu title if your navbar has a versions selector to access old versions of your site.
89+
# This menu appears only if you have at least one [params.versions] set.
90+
version_menu = "Releases"
91+
92+
# Flag used in the "version-banner" partial to decide whether to display a
93+
# banner on every page indicating that this is an archived version of the docs.
94+
# Set this flag to "true" if you want to display the banner.
95+
archived_version = false
96+
97+
# The version number for the version of the docs represented in this doc set.
98+
# Used in the "version-banner" partial to display a version number for the
99+
# current doc set.
100+
version = "1.0"
101+
102+
# A link to latest version of the docs. Used in the "version-banner" partial to
103+
# point people to the main doc site.
104+
url_latest_version = "https://protobuf.dev"
105+
106+
# Repository configuration (URLs for in-page links to opening issues and suggesting changes)
107+
github_repo = "https://github.com/protocolbuffers/protocolbuffers.github.io"
108+
# An optional link to a related project repo. For example, the sibling repository where your product code lives.
109+
github_project_repo = "https://github.com/protocolbuffers/protobuf"
110+
111+
# Specify a value here if your content directory is not in your repo's root directory
112+
github_subdir = "/docs"
113+
114+
# Uncomment this if you have a newer GitHub repo with "main" as the default branch,
115+
# or specify a new value if you want to reference another branch in your GitHub links
116+
# github_branch= "main"
117+
118+
# Google Custom Search Engine ID. Remove or comment out to disable search.
119+
gcs_engine_id = "d72aa9b2712488cc3"
120+
121+
# Enable Algolia DocSearch
122+
algolia_docsearch = false
123+
124+
# Enable Lunr.js offline search
125+
offlineSearch = false
126+
127+
# Enable syntax highlighting and copy buttons on code blocks with Prism
128+
prism_syntax_highlighting = false
129+
130+
# User interface configuration
131+
[params.ui]
132+
# Set to true to disable breadcrumb navigation.
133+
breadcrumb_disable = false
134+
# Set to true to disable the About link in the site footer
135+
footer_about_disable = false
136+
# Set to false if you don't want to display a logo (/assets/icons/logo.svg) in the top navbar
137+
navbar_logo = true
138+
# Set to true if you don't want the top navbar to be translucent when over a `block/cover`, like on the homepage.
139+
navbar_translucent_over_cover_disable = false
140+
# Enable to show the side bar menu in its compact state.
141+
sidebar_menu_compact = false
142+
# Set to true to hide the sidebar search box (the top nav search box will still be displayed if search is enabled)
143+
sidebar_search_disable = false
144+
145+
# ui.sidebar_menu_compact = true
146+
ui.ul_show = 2
147+
ui.sidebar_menu_foldable = true
148+
149+
150+
# Adds a H2 section titled "Feedback" to the bottom of each doc. The responses are sent to Google Analytics as events.
151+
# This feature depends on [services.googleAnalytics] and will be disabled if "services.googleAnalytics.id" is not set.
152+
# If you want this feature, but occasionally need to remove the "Feedback" section from a single page,
153+
# add "hide_feedback: true" to the page's front matter.
154+
[params.ui.feedback]
155+
enable = true
156+
# The responses that the user sees after clicking "yes" (the page was helpful) or "no" (the page was not helpful).
157+
yes = 'Glad to hear it! Please <a href="https://github.com/USERNAME/REPOSITORY/issues/new">tell us how we can improve</a>.'
158+
no = 'Sorry to hear that. Please <a href="https://github.com/USERNAME/REPOSITORY/issues/new">tell us how we can improve</a>.'
159+
160+
# Adds a reading time to the top of each doc.
161+
# If you want this feature, but occasionally need to remove the Reading time from a single page,
162+
# add "hide_readingtime: true" to the page's front matter
163+
[params.ui.readingtime]
164+
enable = false
165+
166+
[params.links]
167+
# End user relevant links. These will show up on left side of footer and in the community page if you have one.
168+
[[params.links.user]]
169+
name = "Stack Overflow"
170+
url = "https://stackoverflow.com/questions/tagged/protocol-buffers"
171+
icon = "fab fa-stack-overflow"
172+
desc = "Practical questions and curated answers"
173+
# Developer relevant links. These will show up on right side of footer and in the community page if you have one.
174+
[[params.links.developer]]
175+
name = "GitHub"
176+
url = "https://github.com/protocolbuffers/protobuf"
177+
icon = "fab fa-github"
178+
desc = "Source code, issues, and other details are stored here."
179+
[[params.links.developer]]
180+
name = "Developer mailing list"
181+
url = "https://groups.google.com/g/protobuf"
182+
icon = "fa fa-envelope"
183+
desc = "Discuss development issues around the project"

content/docs/_index.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,9 @@ toc_hide: true
55
linkTitle: "Protocol Buffers"
66
no_list: "true"
77
type: docs
8+
description: "Protocol Buffers are a language-neutral, platform-neutral extensible mechanism for serializing structured data."
89
---
9-
10+
1011

1112

1213

content/docs/contributing.md

Lines changed: 0 additions & 48 deletions
This file was deleted.

content/docs/downloads.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ toc_hide: false
55
linkTitle: "Downloads"
66
no_list: "true"
77
type: docs
8+
description: "The downloads page for protocol buffers."
89
---
910

1011
## Release Packages

content/docs/getting-started/_index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ toc_hide: false
55
linkTitle: "Tutorials"
66
no_list: "true"
77
type: docs
8+
description: "Each tutorial in this section shows you how to implement a simple application using protocol buffers in your favourite language, introducing you to the language's protocol buffer API as well as showing you the basics of creating and using .proto files."
89
---
910

1011
Each tutorial in this section shows you how to implement a simple application

content/docs/getting-started/cpptutorial.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ toc_hide: false
55
linkTitle: "C++"
66
no_list: "true"
77
type: docs
8+
description: "This tutorial provides a basic C++ programmers introduction to working with protocol buffers."
89
---
910

1011
This tutorial provides a basic C++ programmers introduction to working with

content/docs/getting-started/csharptutorial.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ toc_hide: false
55
linkTitle: "C#"
66
no_list: "true"
77
type: docs
8+
description: "This tutorial provides a basic C# programmers introduction to working with protocol buffers."
89
---
910

1011
This tutorial provides a basic C# programmer's introduction to working with

content/docs/getting-started/darttutorial.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ toc_hide: false
55
linkTitle: "Dart"
66
no_list: "true"
77
type: docs
8+
description: "This tutorial provides a basic Dart programmers introduction to working with protocol buffers."
89
---
910

1011
This tutorial provides a basic Dart programmer's introduction to working with

0 commit comments

Comments
 (0)