Skip to content

Commit 712c2a3

Browse files
committed
docs: move around / delete doc files
Move around `DEVELOPMENT.md` file into the repository root folder. Delete `doc/CODE_OF_CONDUCT.md` and `doc/CONTRIBUTING.md`, both duplicates (already present in the repository root folder). Reuse `doc/CONTRIBUTING.md` content, more up to date. Update file references wherever required, and use relative ones.
1 parent b9831b5 commit 712c2a3

File tree

6 files changed

+13
-81
lines changed

6 files changed

+13
-81
lines changed

.github/pull_request_template.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
## Description
2-
<!-- Thank you for submitting a pull request! Find more information in our development guide at [DEVELOPMENT](https://github.com/awslabs/s3-connector-for-pytorch/blob/main/doc/DEVELOPMENT.md) -->
2+
<!-- Thank you for submitting a pull request! Find more information in our development guide at [DEVELOPMENT](DEVELOPMENT.md) -->
33
<!-- Provide an overview of the PR for maintainers and reviewers. -->
44
<!-- Please ensure your commit messages follow these [guidelines](https://chris.beams.io/posts/git-commit/). -->
55

CONTRIBUTING.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,14 +32,13 @@ To send us a pull request, please:
3232
1. Fork the repository.
3333
2. Modify the source; please focus on the specific change you are contributing. If you also reformat all the code, it will be hard for us to focus on your change.
3434
3. Ensure local tests pass.
35-
4. Commit to your fork using clear commit messages.
35+
4. Commit to your fork using clear commit messages. When writing a Git commit message, follow these [guidelines](https://chris.beams.io/posts/git-commit/).
3636
5. Send us a pull request, answering any default questions in the pull request interface.
3737
6. Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation.
3838

3939
GitHub provides additional document on [forking a repository](https://help.github.com/articles/fork-a-repo/) and
4040
[creating a pull request](https://help.github.com/articles/creating-a-pull-request/).
4141

42-
4342
## Finding contributions to work on
4443
Looking at the existing issues is a great way to find something to contribute on. As our projects, by default, use the default GitHub issue labels (enhancement/bug/duplicate/help wanted/invalid/question/wontfix), looking at any 'help wanted' issues is a great place to start.
4544

File renamed without changes.

README.md

Lines changed: 11 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,8 @@ Amazon S3, without first saving to local storage.
2828
pip install s3torchconnector
2929
```
3030

31-
Amazon S3 Connector for PyTorch supports only Linux via Pip for now. For other platforms, see
32-
[DEVELOPMENT](https://github.com/awslabs/s3-connector-for-pytorch/blob/main/doc/DEVELOPMENT.md) for build instructions.
31+
Amazon S3 Connector for PyTorch supports only Linux via Pip for now. For other platforms,
32+
see [DEVELOPMENT](DEVELOPMENT.md) for build instructions.
3333

3434
### Configuration
3535

@@ -45,8 +45,7 @@ on Unix or macOS.
4545
### Examples
4646

4747
[API docs](http://awslabs.github.io/s3-connector-for-pytorch) are showing API of the public components.
48-
End to end example of how to use `s3torchconnector` can be found under the
49-
[examples](https://github.com/awslabs/s3-connector-for-pytorch/tree/main/examples) directory.
48+
End to end example of how to use `s3torchconnector` can be found under the [examples](examples) directory.
5049

5150
#### Sample Examples
5251

@@ -132,8 +131,8 @@ pip install s3torchconnector[lightning]
132131

133132
### Examples
134133

135-
End to end examples for the Pytorch Lightning integration can be found in the
136-
[examples/lightning](https://github.com/awslabs/s3-connector-for-pytorch/tree/main/examples/lightning) directory
134+
End to end examples for the Pytorch Lightning integration can be found in the [examples/lightning](examples/lightning)
135+
directory.
137136

138137
```py
139138
from lightning import Trainer
@@ -159,13 +158,12 @@ To enable versioning on an S3 bucket, see [Enabling versioning on buckets](https
159158
S3 Versioning and S3 Lifecycle are not supported by S3 Express One Zone.
160159

161160
## Contributing
162-
We welcome contributions to Amazon S3 Connector for PyTorch. Please
163-
see [CONTRIBUTING](https://github.com/awslabs/s3-connector-for-pytorch/blob/main/doc/CONTRIBUTING.md)
164-
For more information on how to report bugs or submit pull requests.
161+
162+
We welcome contributions to Amazon S3 Connector for PyTorch. Please see [CONTRIBUTING](CONTRIBUTING.md) for more
163+
information on how to report bugs or submit pull requests.
165164

166165
### Development
167-
See [DEVELOPMENT](https://github.com/awslabs/s3-connector-for-pytorch/blob/main/doc/DEVELOPMENT.md) for information
168-
about code style, development process, and guidelines.
166+
See [DEVELOPMENT](DEVELOPMENT.md) for information about code style, development process, and guidelines.
169167

170168
### Compatibility with other storage services
171169
S3 Connector for PyTorch delivers high throughput for PyTorch training jobs that access or store data in Amazon S3.
@@ -180,11 +178,8 @@ If you discover a potential security issue in this project we ask that you notif
180178
### Code of conduct
181179

182180
This project has adopted the [Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct).
183-
See [CODE_OF_CONDUCT.md](https://github.com/awslabs/s3-connector-for-pytorch/blob/main/doc/CODE_OF_CONDUCT.md) for
184-
more details.
181+
See [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md) for more details.
185182

186183
## License
187184

188-
Amazon S3 Connector for PyTorch has a BSD 3-Clause License, as found in the
189-
[LICENSE](https://github.com/awslabs/s3-connector-for-pytorch/blob/main/LICENSE) file.
190-
185+
Amazon S3 Connector for PyTorch has a BSD 3-Clause License, as found in the [LICENSE](LICENSE) file.

doc/CODE_OF_CONDUCT.md

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

doc/CONTRIBUTING.md

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

0 commit comments

Comments
 (0)