Skip to content
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

revise wording for building docs tutorial #17

Merged
merged 8 commits into from Jul 27, 2021
Merged

revise wording for building docs tutorial #17

merged 8 commits into from Jul 27, 2021

Conversation

tiffany-taylor
Copy link
Member

This improves upon #15 which uses the directory structure from doc-base's readme. I've also revised some assumptions and notes.

I was not able to fully test the symlink section, but I believe it's correct.

Copy link

@heiglandreas heiglandreas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Only some minor details that tripped me up because of a dockerized setup.

my PHP "binary" looks like this:

#!/bin/bash
docker run -it --rm -v $(pwd):/repo -w /repo mileschou/xdebug:8.0 php $@

As that only mounts the current working directory that is a bit like a chroot environment that needs some tweaks for paths 😉

tutorial/local-setup.md Outdated Show resolved Hide resolved
tutorial/local-setup.md Outdated Show resolved Hide resolved
tutorial/local-setup.md Outdated Show resolved Hide resolved
@tiffany-taylor
Copy link
Member Author

tiffany-taylor commented Jul 26, 2021

I'm noting a comment I placed in the markdown in here, and will remove the comment from markdown. I would like to complete this as a future TODO item, but I'm thinking it will require minor refactoring of the Parsedown script.

  • change text reference "Set up local php.net mirror" into a link that works with markdown and safely converts into HTML for doc.php.net. Currently [Set up a local php.net mirror](/#set-up-a-local-phpnet-mirror) does not appear to correctly convert into HTML.

@salathe
Copy link
Contributor

salathe commented Jul 26, 2021

change text reference "Set up local php.net mirror" into a link that works with markdown and safely converts into HTML for doc.php.net. Currently [Set up a local php.net mirror](/#set-up-a-local-phpnet-mirror) does not appear to correctly convert into HTML.

We should be able to get away with adding an anchor tag with an id, and then linking to that with the id. Parsedown (and really, any Markdown renderer) should be fine with that.

For example:

<a id="set-up-a-local-phpnet-mirror"></a>
## Set up a local php.net mirror
This is explained in the [Set up a local php.net mirror](#set-up-a-local-phpnet-mirror) section.

Copy link
Contributor

@salathe salathe left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks Tiffany!

I have added a few comments, but they're all minor. I'd be happy to see this PR merged as-is and any (or none) of my comments addressed later.

tutorial/local-setup.md Outdated Show resolved Hide resolved
tutorial/local-setup.md Outdated Show resolved Hide resolved
tutorial/local-setup.md Outdated Show resolved Hide resolved
tutorial/local-setup.md Outdated Show resolved Hide resolved
tutorial/local-setup.md Outdated Show resolved Hide resolved
tutorial/local-setup.md Outdated Show resolved Hide resolved
tutorial/local-setup.md Outdated Show resolved Hide resolved
tutorial/local-setup.md Outdated Show resolved Hide resolved
@tiffany-taylor tiffany-taylor merged commit 8cdcc88 into php:master Jul 27, 2021
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.

None yet

3 participants