Skip to content

Commit 6e3ee98

Browse files
hramoshramos
committed
⚛️📱🦖
0 parents  commit 6e3ee98

File tree

1,159 files changed

+261059
-0
lines changed

Some content is hidden

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

1,159 files changed

+261059
-0
lines changed

‎.circleci/config.yml

+82
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
aliases:
2+
- &restore-cache
3+
keys:
4+
- v1-dependencies-{{ arch }}-{{ .Branch }}-{{ checksum "website/package.json" }}
5+
# Fallback in case checksum fails
6+
- v1-dependencies-{{ arch }}-{{ .Branch }}-
7+
8+
- &save-cache
9+
paths:
10+
- website/node_modules
11+
key: v1-dependencies-{{ arch }}-{{ .Branch }}-{{ checksum "website/package.json" }}
12+
13+
- &filter-only-master
14+
branches:
15+
only:
16+
- master
17+
18+
- &filter-ignore-gh-pages
19+
branches:
20+
ignore: gh-pages
21+
22+
defaults: &defaults
23+
working_directory: ~/react-native-website
24+
docker:
25+
- image: circleci/node:8
26+
27+
version: 2
28+
jobs:
29+
# Tests website
30+
test-website:
31+
<<: *defaults
32+
steps:
33+
- checkout
34+
- run:
35+
name: Install Dependencies
36+
command: |
37+
cd website
38+
yarn --no-progress
39+
- run:
40+
name: Test Website
41+
command: |
42+
cd website
43+
yarn test
44+
45+
# Deploys website
46+
deploy-website:
47+
<<: *defaults
48+
steps:
49+
- checkout
50+
- run:
51+
name: Install Dependencies
52+
command: |
53+
cd website
54+
yarn --no-progress
55+
- run:
56+
name: Build and Deploy Static Website
57+
command: |
58+
if [[ $CIRCLE_PROJECT_USERNAME == "facebook" && -z $CI_PULL_REQUEST && -z $CIRCLE_PR_USERNAME ]]; then
59+
git config --global user.email "[email protected]"
60+
git config --global user.name "Website Deployment Script"
61+
echo "machine github.com login reactjs-bot password $GITHUB_TOKEN" > ~/.netrc
62+
echo "Deploying website..."
63+
cd website && GIT_USER=reactjs-bot CIRCLE_PROJECT_REPONAME=react-native yarn run publish-gh-pages
64+
else
65+
echo "Skipping deploy."
66+
fi
67+
68+
# Workflows enables us to run multiple jobs in parallel
69+
workflows:
70+
version: 2
71+
72+
build:
73+
jobs:
74+
# Test website
75+
- test-website:
76+
filters: *filter-ignore-gh-pages
77+
78+
# If we are on master, deploy docs
79+
- deploy-website:
80+
filters: *filter-only-master
81+
requires:
82+
- test-website

‎.github/PULL_REQUEST_TEMPLATE.md

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
Thank you for the PR! Contributors like you keep React Native awesome!
2+
3+
Please see the Contribution Guide for guidelines:
4+
5+
https://github.com/facebook/react-native-website/blob/master/CONTRIBUTING.md
6+
7+
If your PR references an existing issue, please add the issue number below:
8+
9+
#<Issue>

‎.gitignore

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
node_modules
2+
.DS_Store
3+
lib/core/metadata.js
4+
lib/core/MetadataBlog.js
5+
website/translated_docs
6+
website/build/
7+
website/yarn.lock
8+
website/node_modules
9+
10+
website/i18n/*
11+
!website/i18n/en.json
12+
13+
.nvmrc

‎CODE_OF_CONDUCT.md

+100
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,100 @@
1+
# [Open Source Code of Conduct](https://code.facebook.com/codeofconduct)
2+
3+
This code of conduct outlines our expectations for participants within the
4+
**Facebook Open Source** community, as well as steps to reporting unacceptable
5+
behavior. We are committed to providing a welcoming and inspiring community for
6+
all and expect our code of conduct to be honored. Anyone who violates this code
7+
of conduct may be banned from the community.
8+
9+
Our open source community strives to:
10+
11+
* **Be friendly and patient.**
12+
* **Be welcoming:** We strive to be a community that welcomes and supports
13+
people of all backgrounds and identities. This includes, but is not limited to
14+
members of any race, ethnicity, culture, national origin, colour, immigration
15+
status, social and economic class, educational level, sex, sexual orientation,
16+
gender identity and expression, age, size, family status, political belief,
17+
religion, and mental and physical ability.
18+
* **Be considerate:** Your work will be used by other people, and you in turn
19+
will depend on the work of others. Any decision you take will affect users and
20+
colleagues, and you should take those consequences into account when making
21+
decisions. Remember that we’re a world-wide community, so you might not be
22+
communicating in someone else’s primary language.
23+
* **Be respectful:** Not all of us will agree all the time, but disagreement is
24+
no excuse for poor behavior and poor manners. We might all experience some
25+
frustration now and then, but we cannot allow that frustration to turn into a
26+
personal attack. It’s important to remember that a community where people feel
27+
uncomfortable or threatened is not a productive one.
28+
* **Be careful in the words that you choose:** we are a community of
29+
professionals, and we conduct ourselves professionally. Be kind to others. Do
30+
not insult or put down other participants. Harassment and other exclusionary
31+
behavior aren’t acceptable. This includes, but is not limited to:
32+
* Violent threats or language directed against another person.
33+
* Discriminatory jokes and language.
34+
* Posting sexually explicit or violent material.
35+
* Posting (or threatening to post) other people’s personally identifying
36+
information (“doxing”).
37+
* Personal insults, especially those using racist or sexist terms.
38+
* Unwelcome sexual attention.
39+
* Advocating for, or encouraging, any of the above behavior.
40+
* Repeated harassment of others. In general, if someone asks you to stop, then
41+
stop.
42+
* **When we disagree, try to understand why:** Disagreements, both social and
43+
technical, happen all the time. It is important that we resolve disagreements
44+
and differing views constructively.
45+
* **Remember that we’re different.** The strength of our community comes from
46+
its diversity, people from a wide range of backgrounds. Different people have
47+
different perspectives on issues. Being unable to understand why someone holds
48+
a viewpoint doesn’t mean that they’re wrong. Don’t forget that it is human to
49+
err and blaming each other doesn’t get us anywhere. Instead, focus on helping
50+
to resolve issues and learning from mistakes.
51+
52+
This code is not exhaustive or complete. It serves to distill our common
53+
understanding of a collaborative, shared environment, and goals. We expect it to
54+
be followed in spirit as much as in the letter.
55+
56+
## Diversity Statement
57+
58+
We encourage everyone to participate and are committed to building a community
59+
for all. Although we may not be able to satisfy everyone, we all agree that
60+
everyone is equal. Whenever a participant has made a mistake, we expect them to
61+
take responsibility for it. If someone has been harmed or offended, it is our
62+
responsibility to listen carefully and respectfully, and do our best to right
63+
the wrong.
64+
65+
Although this list cannot be exhaustive, we explicitly honor diversity in age,
66+
gender, gender identity or expression, culture, ethnicity, language, national
67+
origin, political beliefs, profession, race, religion, sexual orientation,
68+
socioeconomic status, and technical ability. We will not tolerate discrimination
69+
based on any of the protected characteristics above, including participants with
70+
disabilities.
71+
72+
## Reporting Issues
73+
74+
If you experience or witness unacceptable behavior—or have any other
75+
concerns—please report it by contacting us via [email protected]. All reports
76+
will be handled with discretion. In your report please include:
77+
78+
* Your contact information.
79+
* Names (real, nicknames, or pseudonyms) of any individuals involved. If there
80+
are additional witnesses, please include them as well. Your account of what
81+
occurred, and if you believe the incident is ongoing. If there is a publicly
82+
available record (e.g. a mailing list archive or a public IRC logger), please
83+
include a link.
84+
* Any additional information that may be helpful.
85+
86+
After filing a report, a representative will contact you personally. If the
87+
person who is harassing you is part of the response team, they will recuse
88+
themselves from handling your incident. A representative will then review the
89+
incident, follow up with any additional questions, and make a decision as to how
90+
to respond. We will respect confidentiality requests for the purpose of
91+
protecting victims of abuse.
92+
93+
Anyone asked to stop unacceptable behavior is expected to comply immediately. If
94+
an individual engages in unacceptable behavior, the representative may take any
95+
action they deem appropriate, up to and including a permanent ban from our
96+
community without warning.
97+
98+
_This Code Of Conduct follows the
99+
[template](http://todogroup.org/opencodeofconduct/) established by the
100+
[TODO Group](http://todogroup.org/)._

‎CONTRIBUTING.md

+69
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
# Contributing
2+
3+
Thank you for your interest in contributing to the React Native Docs!
4+
5+
## Code of Conduct
6+
7+
Facebook has adopted a Code of Conduct that we expect project participants to
8+
adhere to. Please [read the full text](https://code.facebook.com/codeofconduct)
9+
so that you can understand what actions will and will not be tolerated.
10+
11+
## Guidelines for Text
12+
13+
**Different sections intentionally have different styles.**
14+
15+
The documentation is divided into sections to cater to different learning styles
16+
and use cases. When editing an article, try to match the surrounding text in
17+
tone and style. When creating a new article, try to match the tone of the other
18+
articles in the same section. Learn about the motivation behind each section
19+
below.
20+
21+
**[Getting Started](https://facebook.github.io/react-native/docs/tutorial.html)**
22+
is relatively informal. Resist adding too much detail to the Quick Start. The
23+
native code instructions should contain the minimal set of steps to get to a
24+
working development environment, and is expected to contain a longer set of
25+
steps to get a working development environment. Whatever the case, it should be
26+
possible for a beginner to mechanically follow every instruction, and still get
27+
to a working React Native app.
28+
29+
**[The Basics](https://facebook.github.io/react-native/docs/tutorial.html)** is
30+
designed to introduce fundamental concepts in a step-by-step way. Each
31+
individual article in The Basics builds on the knowledge from the previous ones,
32+
so make sure not to add any "cyclical dependencies" between them. It is
33+
important that the reader can start with the first article and work their way to
34+
the last Basics article without ever having to "look ahead" for a definition.
35+
This explains some ordering choices. Resist adding too much detail to Basics
36+
articles. They intentionally don't cover all corner cases, and focus on
37+
establishing firm foundations.
38+
39+
**[Guides](https://facebook.github.io/react-native/docs/components-and-apis.html)**
40+
are deep dives into topics that aren't essential for a beginner developer but
41+
that everyone bumps into sooner or later. They don't have a specific order, and
42+
target more experienced developers. If you have a set of recipes fitting a
43+
particular use case, and those recipes aren't opinionated (most React Native
44+
users would agree on them), this is the place to add them.
45+
46+
**[Reference](https://facebook.github.io/react-native/docs/activityindicator.html)**
47+
is organized by APIs rather than concepts. It is intended to be exhaustive. Any
48+
corner cases or recommendations that were skipped for brevity in The Basics or
49+
Guides should be mentioned in the reference documentation for the corresponding
50+
APIs.
51+
52+
**[Contributing](https://facebook.github.io/react-native/docs/contributing.html)**
53+
should stay up-to-date and be friendly to relatively experienced developers.
54+
55+
**[More Resources](https://facebook.github.io/react-native/docs/more-resources.html)**
56+
has a more conversational tone than the other sections. Here, it's fine to
57+
include some content that's not primarily concerned with React Native, as long
58+
as React Native users are overwhelmingly interested in it (e.g. recommendations
59+
on which libraries to use).
60+
61+
**Try to follow your own instructions.**
62+
63+
When writing step-by-step instructions (e.g. how to install something), try to
64+
forget everything you know about the topic, and actually follow the instructions
65+
you wrote, a single step at time. Often you will discover that there is implicit
66+
knowledge that you forgot to mention, or that there are missing or out-of-order
67+
steps in the instructions. Bonus points for getting _somebody else_ to follow
68+
the steps and watching what they struggle with. Often it would be something very
69+
simple that you have not anticipated.

0 commit comments

Comments
 (0)