Skip to content

Commit

Permalink
Changes for i18n
Browse files Browse the repository at this point in the history
Signed-off-by: Anthony O'Dowd <a_o-dowd@uk.ibm.com>
(cherry picked from commit a3be61a)
  • Loading branch information
ODOWDAIBM authored and lindluni committed Jul 10, 2020
1 parent 5f11b9b commit 9bca8d6
Show file tree
Hide file tree
Showing 5 changed files with 532 additions and 441 deletions.
161 changes: 57 additions & 104 deletions docs/Pipfile.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

10 changes: 5 additions & 5 deletions docs/source/CONTRIBUTING.rst
Expand Up @@ -93,17 +93,17 @@ Contributing documentation
--------------------------

It's a good idea to make your first change a documentation change. It's quick
and easy to do, checks that you have a correctly configured machine, (including
the required pre-requisite software), and gets you familiar with the whole
process. Use the following sections to help you get started:
and easy to do, ensures that you have a correctly configured machine, (including
the required pre-requisite software), and gets you familiar with the
contribution process. Use the following topics to help you get started:

.. toctree::
:maxdepth: 1

advice_for_writers
docs_guide
style_guide
international_languages

style_guide

Project Governance
------------------
Expand Down
75 changes: 75 additions & 0 deletions docs/source/advice_for_writers.md
@@ -0,0 +1,75 @@
# Connect with other writers

**Audience**: Writers who would like to contribute to the Fabric documentation.

This topic gives you general advice on how to contribute to one of the many
language translations provided by Fabric.

In this topic, we're going to cover:

* [How to get started](#getting-started)
* [Using Rocket chat](#rocket-chat)
* [Documentation workgroup call](#documentation-workgroup-call)
* [Join a language translation workgroup](#join-a-language-translation-workgroup)
* [Other ways to connect](#other-ways-to-connect)

## Getting started

Before you make a documentation change, you might like to connect with other
people working on the Fabric documentation. Your [Linux Foundation
account](./contributing.html#getting-a-linux-foundation-account) will give you
access to many different resources to help you connect with other contributors
to the documentation.

Once you have a Linux Foundation account, use any or all of the following
mechanisms to connect with others.

## Rocket chat

Hyperledger Fabric uses [Rocket chat](https://chat.hyperledger.org/home) for
interactive discussions on a variety of project topics.

* [Documentation
channel](https://chat.hyperledger.org/channel/fabric-documentation)

You'll find beginners and experts sharing information on the Fabric
documentation. Read the conversation or ask a question on how to get started.


* [International languages channel](https://chat.hyperledger.org/channel/i18n)

A dedicated channel for general questions on international languages.


* [Japanese
channel](https://chat.hyperledger.org/channel/fabric-docs-japanese)

Read, discuss and share ideas related to the Japanese translation.

## Documentation workgroup call

A great place to meet people working on documentation is the Documentation workgroup
call. These are held twice every Friday at a time convenient for both
Eastern and Western hemispheres. The agenda is published in advance, and
there are minutes and recordings of each session. Find out more on the
[Documentation
wiki](https://wiki.hyperledger.org/display/fabric/Documentation+Working+Group).

## Join a language translation workgroup

Each of the international languages has a welcoming workgroup that you are
encouraged to join. View the [list of international
workgroups](https://wiki.hyperledger.org/display/fabric/International+groups).
See what your favorite workgroup is doing, and get connected with them.
Each workgroup has a list of members and their contact information.

## Other ways to connect

Hyperledger Fabric has many other collaboration mechanisms such as mailing
lists, contributor meetings and maintainer meetings. Find out about these and
more [here](./contributing.html).

Good luck getting started and thanks for your contribution.

<!--- Licensed under Creative Commons Attribution 4.0 International License
https://creativecommons.org/licenses/by/4.0/ -->

0 comments on commit 9bca8d6

Please sign in to comment.