Skip to content

DOP-4884: Remove docs/: moved to mongodb/docs-php-library #1367

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Aug 2, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 0 additions & 4 deletions .github/workflows/tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,11 @@ on:
- "v*.*"
- "master"
- "feature/*"
paths-ignore:
- "docs/**"
push:
branches:
- "v*.*"
- "master"
- "feature/*"
paths-ignore:
- "docs/**"

env:
# TODO: change to "stable" once 1.20.0 is released
Expand Down
28 changes: 3 additions & 25 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -172,31 +172,9 @@ New rules can be added to the `rector.php` configuration file.

## Documentation

Documentation for the library lives in the `docs/` directory and is built with
tools in the related
[mongodb/docs-php-library](https://github.com/mongodb/docs-php-library)
repository. The tools repository is already configured to reference our sources.

That said, any changes to the documentation should be tested locally before
committing. Follow the following steps to build the docs locally with the tools
repository:

* Clone the
[mongodb/docs-php-library](https://github.com/mongodb/docs-php-library) tools
repository.
* Create and activate Python 2.7 virtual environment if necessary.

```console
$ virtualenv -p python2.7 venv
$ source venv/bin/activate
```
* Install [giza](https://pypi.python.org/pypi/giza/) according to the instructions
in the [mongodb/docs-tools](https://github.com/mongodb/docs-tools) README.
* Sync your working copy of the documentation to the `source/` directory with
`rsync -a --delete /path/to/mongo-php-library/docs/ source/`.
* Build the documentation with `giza make publish`. You can suppress
informational log messages with the `--level warning` option.
* Generated documentation may be found in the `build/master/html` directory.
Documentation for the library is maintained by the MongoDB docs team and is kept
in the [mongodb/docs-php-library](https://github.com/mongodb/docs-php-library)
repository.

## Releasing

Expand Down
Empty file removed docs/.static/.mongodb
Empty file.
19 changes: 0 additions & 19 deletions docs/examples/aws-lambda/composer.json

This file was deleted.

31 changes: 0 additions & 31 deletions docs/examples/aws-lambda/index.php

This file was deleted.

22 changes: 0 additions & 22 deletions docs/examples/aws-lambda/serverless.yml

This file was deleted.

60 changes: 0 additions & 60 deletions docs/examples/codecs/handling-data-types/DateTimeCodec.php

This file was deleted.

13 changes: 0 additions & 13 deletions docs/examples/codecs/handling-data-types/Person.php

This file was deleted.

55 changes: 0 additions & 55 deletions docs/examples/codecs/handling-data-types/PersonCodec.php

This file was deleted.

12 changes: 0 additions & 12 deletions docs/examples/codecs/handling-documents/Person.php

This file was deleted.

49 changes: 0 additions & 49 deletions docs/examples/codecs/handling-documents/PersonCodec.php

This file was deleted.

7 changes: 0 additions & 7 deletions docs/examples/codecs/handling-documents/disabling-codec.php

This file was deleted.

13 changes: 0 additions & 13 deletions docs/examples/codecs/handling-documents/using-codec.php

This file was deleted.

12 changes: 0 additions & 12 deletions docs/examples/codecs/handling-embedded-documents/Address.php

This file was deleted.

Loading