Skip to content

PHPLIB-523, PHPLIB-524: Restructure docs index and install pages #764

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 3 commits into from
Jul 9, 2020

Conversation

jmikola
Copy link
Member

@jmikola jmikola commented Jul 9, 2020

https://jira.mongodb.org/browse/PHPLIB-523
https://jira.mongodb.org/browse/PHPLIB-524

A third commit also fixes various syntax/formatting issues I noticed while working on these two pages.

Opening against v1.1 as I can apply there and merge up to master so this changes applies to all published versions of the manual. Separately, I'd propose we consider hiding some older version in the drop-down. I can't imagine that docs for v1.1 is very relevant for anyone.

To build locally from a clone of https://github.com/mongodb/docs-php-library with this repo cloned in ../phplib:

#!/bin/sh

rm -r build/master
rsync -a --delete ../phplib/docs/ source/
giza -l warning make publish

You can then serve the docs with:

#!/bin/sh

php -S localhost:8080 -t ./build/master/html/

jmikola added 3 commits July 8, 2020 22:12
This revises the intro text and links to PHPLIB and MongoDB tutorials.
This adds inline instructions for installing the extension in lieu of sending readers to PHP.net.
@jmikola jmikola requested a review from alcaeus July 9, 2020 02:20
@jmikola jmikola merged commit d66c807 into mongodb:v1.1 Jul 9, 2020
@jmikola jmikola deleted the 1.1-docs_index_install branch July 9, 2020 11:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants