Skip to content

Commit ae90282

Browse files
authored
[docs] Restructure README.md content (#1257)
* Refactor README.md content * bump to run ci jobs
1 parent 1375fd1 commit ae90282

File tree

4 files changed

+364
-333
lines changed

4 files changed

+364
-333
lines changed

.github/workflows/build.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ jobs:
5555
echo $PATH
5656
python3 --version
5757
python3 -c 'import site; print(site.getsitepackages())'
58-
python3 .github/workflows/build.instruction.py --sudo=true README.md "#### macOS" > source.sh
58+
python3 .github/workflows/build.instruction.py --sudo=true docs/development.md "#### macOS" > source.sh
5959
bash -x -e source.sh
6060
python3 -c 'import tensorflow as tf; print(tf.version.VERSION)'
6161
@@ -67,7 +67,7 @@ jobs:
6767
- run: |
6868
set -x -e
6969
bash -x -e .github/workflows/build.space.sh
70-
python3 .github/workflows/build.instruction.py README.md "##### Ubuntu 20.04" > source.sh
70+
python3 .github/workflows/build.instruction.py docs/development.md "##### Ubuntu 20.04" > source.sh
7171
cat source.sh
7272
docker run -i --rm -v $PWD:/v -w /v --net=host ubuntu:20.04 \
7373
bash -x -e source.sh
@@ -80,7 +80,7 @@ jobs:
8080
- run: |
8181
set -x -e
8282
bash -x -e .github/workflows/build.space.sh
83-
python3 .github/workflows/build.instruction.py README.md "##### CentOS 7" > source.sh
83+
python3 .github/workflows/build.instruction.py docs/development.md "##### CentOS 7" > source.sh
8484
cat source.sh
8585
docker run -i --rm -v $PWD:/v -w /v --net=host centos:7 \
8686
bash -x -e source.sh

CONTRIBUTING.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
# Contributing
22

3-
Tensorflow I/O project welcomes all kinds of contributions, be it code changes, bug-fixes or documentation changes.
4-
This guide should help you in taking care of some basic setups & code conventions.
3+
Tensorflow I/O project welcomes all kinds of contributions, be it code changes, bug-fixes or documentation changes. This guide should help you in taking care of some basic setups & code conventions.
54

65
## Contributor License Agreement
76

@@ -17,8 +16,7 @@ again.
1716

1817
## Coding Style
1918

20-
Tensorflow project wide code style guidelines can be followed at [TensorFlow Style Guide - Conventions](https://www.tensorflow.org/community/contribute/code_style) and Tensorflow I/O project specific
21-
code style guidelines can be followed at [Style Guide](STYLE_GUIDE.md).
19+
Tensorflow project wide code style guidelines can be followed at [TensorFlow Style Guide - Conventions](https://www.tensorflow.org/community/contribute/code_style) and Tensorflow I/O project specific code style guidelines can be followed at [Style Guide](STYLE_GUIDE.md).
2220

2321
## Code Reviews
2422

0 commit comments

Comments
 (0)