Chromium Code Reviews
|
|
Chromium Code Reviews
Issue
1822123002:
docs: convert windows build instructions from html to markdown (Closed)
Descriptiondocs: convert windows build instructions from html to markdown
This patch converts Windows Build Instructions from
https://www.chromium.org/developers/how-tos/build-instructions-windows
to Markdown and check it in docs/ directory.
The process for doing this was done partially by command line tools
and partially manually after inspection at http://dillinger.io/.
The command lines to generate the markdown file were:
$ wget https://www.chromium.org/developers/how-tos/build-instructions-windows
$ pandoc -s -r html build-instructions-windows -o windows_build_instructions.md
BUG=None
TEST=opened windows_build_instructions.md in dillinger.io and visually
inspected it.
R=brucedawson@chromium.org,dpranke@chromium.org
Committed: https://crrev.com/502f38896d66b875a80ea32b747eeac0f5019d5e
Cr-Commit-Position: refs/heads/master@{#382835}
Patch Set 1 #
Total comments: 2
Patch Set 2 : VS 2015 first now #Messages
Total messages: 23 (5 generated)
Hi Bruce, we are trying to convert the build instructions from the html to markdown. I have talked with some people in the CC list before doing this and got green light from them. Sylvain can help review this (if he has time) as well (as he already reviewed the iOS changes I did) if you are not familiar with Markdown language and not confortable in approving this. I put Dirk on reviewers list as he reviewed the previous Cast change. I'm happy to iterate further after this lands to make sure the end result in Gitiles looks good, like I did for the iOS instructions. PTAL. Thank you,
Description was changed from ========== docs: convert windows build instructions from html to markdown This patch converts WIndows Build Instructions from https://www.chromium.org/developers/how-tos/build-instructions-windows to Markdown and check it in docs/ directory. The process for doing this was done partially by command line tools and partially manually after inspection at http://dillinger.io/. The command lines to generate the markdown file were: $ wget https://www.chromium.org/developers/how-tos/build-instructions-windows $ pandoc -s -r html build-instructions-windows -o windows_build_instructions.md BUG=None TEST=opened windows_build_instructions.md in dillinger.io and visually inspected it. R=brucedawson@chromium.org,dpranke@chromium.org ========== to ========== docs: convert windows build instructions from html to markdown This patch converts Windows Build Instructions from https://www.chromium.org/developers/how-tos/build-instructions-windows to Markdown and check it in docs/ directory. The process for doing this was done partially by command line tools and partially manually after inspection at http://dillinger.io/. The command lines to generate the markdown file were: $ wget https://www.chromium.org/developers/how-tos/build-instructions-windows $ pandoc -s -r html build-instructions-windows -o windows_build_instructions.md BUG=None TEST=opened windows_build_instructions.md in dillinger.io and visually inspected it. R=brucedawson@chromium.org,dpranke@chromium.org ==========
looks fine to me, with one minor comment. tfarina, are you aware that you can use `python tools/md_browser/md_browser.py` to review your changes locally as well? https://codereview.chromium.org/1822123002/diff/1/docs/windows_build_instruct... File docs/windows_build_instructions.md (right): https://codereview.chromium.org/1822123002/diff/1/docs/windows_build_instruct... docs/windows_build_instructions.md:39: 2016): I would probably put these instructions before the 2013 instructions now.
On 2016/03/22 18:36:17, Dirk Pranke wrote: > looks fine to me, with one minor comment. i.e., lgtm.
On 2016/03/22 18:36:17, Dirk Pranke wrote: > looks fine to me, with one minor comment. > > tfarina, are you aware that you can use `python tools/md_browser/md_browser.py` > to review your changes locally as well? > Yeah. :) Well, I should, but then I would need to vnc into my machine rather than just ssh into it.
https://codereview.chromium.org/1822123002/diff/1/docs/windows_build_instruct... File docs/windows_build_instructions.md (right): https://codereview.chromium.org/1822123002/diff/1/docs/windows_build_instruct... docs/windows_build_instructions.md:39: 2016): On 2016/03/22 18:36:17, Dirk Pranke wrote: > I would probably put these instructions before the 2013 instructions now. Done.
The CQ bit was checked by tfarina@chromium.org
The patchset sent to the CQ was uploaded after l-g-t-m from dpranke@chromium.org Link to the patchset: https://codereview.chromium.org/1822123002/#ps20001 (title: "VS 2015 first now")
CQ is trying da patch. Follow status at https://chromium-cq-status.appspot.com/patch-status/1822123002/20001 View timeline at https://chromium-cq-status.appspot.com/patch-timeline/1822123002/20001
Message was sent while issue was closed.
Description was changed from ========== docs: convert windows build instructions from html to markdown This patch converts Windows Build Instructions from https://www.chromium.org/developers/how-tos/build-instructions-windows to Markdown and check it in docs/ directory. The process for doing this was done partially by command line tools and partially manually after inspection at http://dillinger.io/. The command lines to generate the markdown file were: $ wget https://www.chromium.org/developers/how-tos/build-instructions-windows $ pandoc -s -r html build-instructions-windows -o windows_build_instructions.md BUG=None TEST=opened windows_build_instructions.md in dillinger.io and visually inspected it. R=brucedawson@chromium.org,dpranke@chromium.org ========== to ========== docs: convert windows build instructions from html to markdown This patch converts Windows Build Instructions from https://www.chromium.org/developers/how-tos/build-instructions-windows to Markdown and check it in docs/ directory. The process for doing this was done partially by command line tools and partially manually after inspection at http://dillinger.io/. The command lines to generate the markdown file were: $ wget https://www.chromium.org/developers/how-tos/build-instructions-windows $ pandoc -s -r html build-instructions-windows -o windows_build_instructions.md BUG=None TEST=opened windows_build_instructions.md in dillinger.io and visually inspected it. R=brucedawson@chromium.org,dpranke@chromium.org ==========
Message was sent while issue was closed.
Committed patchset #2 (id:20001)
Message was sent while issue was closed.
Description was changed from ========== docs: convert windows build instructions from html to markdown This patch converts Windows Build Instructions from https://www.chromium.org/developers/how-tos/build-instructions-windows to Markdown and check it in docs/ directory. The process for doing this was done partially by command line tools and partially manually after inspection at http://dillinger.io/. The command lines to generate the markdown file were: $ wget https://www.chromium.org/developers/how-tos/build-instructions-windows $ pandoc -s -r html build-instructions-windows -o windows_build_instructions.md BUG=None TEST=opened windows_build_instructions.md in dillinger.io and visually inspected it. R=brucedawson@chromium.org,dpranke@chromium.org ========== to ========== docs: convert windows build instructions from html to markdown This patch converts Windows Build Instructions from https://www.chromium.org/developers/how-tos/build-instructions-windows to Markdown and check it in docs/ directory. The process for doing this was done partially by command line tools and partially manually after inspection at http://dillinger.io/. The command lines to generate the markdown file were: $ wget https://www.chromium.org/developers/how-tos/build-instructions-windows $ pandoc -s -r html build-instructions-windows -o windows_build_instructions.md BUG=None TEST=opened windows_build_instructions.md in dillinger.io and visually inspected it. R=brucedawson@chromium.org,dpranke@chromium.org Committed: https://crrev.com/502f38896d66b875a80ea32b747eeac0f5019d5e Cr-Commit-Position: refs/heads/master@{#382835} ==========
Message was sent while issue was closed.
Patchset 2 (id:??) landed as https://crrev.com/502f38896d66b875a80ea32b747eeac0f5019d5e Cr-Commit-Position: refs/heads/master@{#382835}
Message was sent while issue was closed.
The page at https://www.chromium.org/developers/how-tos/build-instructions-windows is currently showing the old documentation - how/when does it get switched?
Message was sent while issue was closed.
On 2016/03/23 21:02:45, brucedawson wrote: > The page at > https://www.chromium.org/developers/how-tos/build-instructions-windows is > currently showing the old documentation - how/when does it get switched? The docs are in two different systems; www.chromium.org is served by Google Sites. We need to update that page to link to the new one.
Message was sent while issue was closed.
> We need to update that page to link to the new one. Sounds good. Do we just delete the existing page and replace it with a link, or is there some better system? Jonathan Ross just added a comment with a link to the new location but the link doesn't actually work. tfarina@ - you going to make the switch?
Message was sent while issue was closed.
On 2016/03/24 20:07:52, brucedawson wrote: > tfarina@ - you going to make the switch? Yes, I'm going to handle the switch.
Message was sent while issue was closed.
On 2016/03/24 20:09:29, tfarina wrote: > On 2016/03/24 20:07:52, brucedawson wrote: > > tfarina@ - you going to make the switch? > Yes, I'm going to handle the switch. The results on https://chromium.googlesource.com/chromium/src/+/master/docs/windows_build_in... don't look the same as they do if I past the same markdown into http://dillinger.io/. In particular the Open source contributors instructions on how to install VS 2015 or VS 2013 are not highlighted effectively in the chromium.googlesource.com version. Different versions of markdown perhaps? Specifically, it feels like the leading "> " directives are being ignored. There are other differences but that is the main one that is clearly worse. Any thoughts? I'd be happy to try fixing it but it's tough when the preferred preview tool is showing different results.
Message was sent while issue was closed.
On 2016/03/29 at 23:51:54, brucedawson wrote: > On 2016/03/24 20:09:29, tfarina wrote: > > On 2016/03/24 20:07:52, brucedawson wrote: > > > tfarina@ - you going to make the switch? > > Yes, I'm going to handle the switch. > > The results on https://chromium.googlesource.com/chromium/src/+/master/docs/windows_build_in... don't look the same as they do if I past the same markdown into http://dillinger.io/. In particular the Open source contributors instructions on how to install VS 2015 or VS 2013 are not highlighted effectively in the chromium.googlesource.com version. Different versions of markdown perhaps? > > Specifically, it feels like the leading "> " directives are being ignored. There are other differences but that is the main one that is clearly worse. Any thoughts? I'd be happy to try fixing it but it's tough when the preferred preview tool is showing different results. I can confirm that md_browser.py is rendering those blocks differently from Gitiles (it renders them indented; gitiles doesn't). dpranke@, do you know why?
Message was sent while issue was closed.
On 2016/03/29 23:57:37, agable wrote: > On 2016/03/29 at 23:51:54, brucedawson wrote: > > On 2016/03/24 20:09:29, tfarina wrote: > > > On 2016/03/24 20:07:52, brucedawson wrote: > > > > tfarina@ - you going to make the switch? > > > Yes, I'm going to handle the switch. > > > > The results on > https://chromium.googlesource.com/chromium/src/+/master/docs/windows_build_in... > don't look the same as they do if I past the same markdown into > http://dillinger.io/. In particular the Open source contributors instructions on > how to install VS 2015 or VS 2013 are not highlighted effectively in the > http://chromium.googlesource.com version. Different versions of markdown perhaps? > > > > Specifically, it feels like the leading "> " directives are being ignored. > There are other differences but that is the main one that is clearly worse. Any > thoughts? I'd be happy to try fixing it but it's tough when the preferred > preview tool is showing different results. > > I can confirm that md_browser.py is rendering those blocks differently from > Gitiles (it renders them indented; gitiles doesn't). dpranke@, do you know why? Both blocks are being rendered in <blockquote>, but the styling (CSS) is quite different. It looks like Gitiles probably did a refresh at some point and is apply resets now but not then re-styling blockquotes, so you're losing the default styling on the blockquote. Which is probably a bug that should be filed against Gitiles.
Message was sent while issue was closed.
https://code.google.com/p/gitiles/issues/detail?id=105 filed.
Message was sent while issue was closed.
On 2016/03/30 01:01:37, brucedawson wrote: > https://code.google.com/p/gitiles/issues/detail?id=105 filed. Note also that the md_browser rendering should generally match gitiles, but I do not have any way of making that always be true; I need to manually track changes. So, it might be good to also file a request that I do a refresh for md_browser as well :).
Message was sent while issue was closed.
No point updating md_browser.py to make gitiles until gitiles looks reasonable. |
