Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Contribute to GitLab
Sign in
Toggle navigation
M
mongo-php-library
Project
Project
Details
Activity
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
0
Issues
0
List
Board
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Charts
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
sinan
mongo-php-library
Commits
cdc20604
Commit
cdc20604
authored
Oct 17, 2016
by
Jeremy Mikola
Browse files
Options
Browse Files
Download
Plain Diff
Merge pull request #273
parents
2665bc30
4c683f02
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
30 additions
and
0 deletions
+30
-0
CONTRIBUTING.md
CONTRIBUTING.md
+30
-0
No files found.
CONTRIBUTING.md
View file @
cdc20604
...
@@ -44,6 +44,36 @@ By default, the PHPUnit script relies on the `php` interpreter for your shell
...
@@ -44,6 +44,36 @@ By default, the PHPUnit script relies on the `php` interpreter for your shell
$ hhvm vendor/bin/phpunit
$ hhvm vendor/bin/phpunit
```
```
## 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.
*
Install
[
giza
](
https://pypi.python.org/pypi/giza/
)
, as noted in the tools
README.
*
Comment out the following
`assets`
entry in
`config/build_conf.yaml`
:
```
- branch: master
path: build/php-library # this is where we'll put the source docs (from the driver repo)
repository: https://github.com/mongodb/mongo-php-library.git
```
* Create a symlink so that `build/php-library` points to your working copy of
the [mongodb/mongo-php-library](https://github.com/mongodb/mongo-php-library)
repository.
* Build the documentation with `gize make html`. You can suppress informational
log messages via the `--level warning` option.
* Generated documentation may be found in the `build/master/html` directory.
## Releasing
## Releasing
The follow steps outline the release process for a maintenance branch (e.g.
The follow steps outline the release process for a maintenance branch (e.g.
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment