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.

Sign up for GitHub

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

Jump to bottom

Use Readme.com's new Markdown syntax #15845

Merged
merged 2 commits into from
Jun 16, 2022
Merged

Use Readme.com's new Markdown syntax #15845

merged 2 commits into from
Jun 16, 2022

Conversation

Eric-Arellano
Copy link
Contributor

Readme is migrating to a new editor, which uses a much more intuitive Markdown syntax than their old "raw mode". It is easier to read and renders better in Markdown renders.

Their export button used their old syntax in most places. So, I manually copied and pasted every page using their new editor to fix things.

This makes no content changes - only changes the syntax.

[ci skip-rust]
[ci skip-build-wheels]

@Eric-Arellano
Use Readme.com's new Markdown syntax
561df72 
# Rust tests and lints will be skipped. Delete if not intended.
[ci skip-rust]

# Building wheels and fs_util will be skipped. Delete if not intended.
[ci skip-build-wheels]
@Eric-Arellano Eric-Arellano added the category:internal CI, fixes for not-yet-released features, etc. label Jun 16, 2022
Eric-Arellano
Eric-Arellano commented Jun 16, 2022
View reviewed changes
Copy link
Contributor Author

@Eric-Arellano Eric-Arellano left a comment

Choose a reason for hiding this comment

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

I audited every page as closely as I could...commented on things worth extra attention.

docs/markdown/Contributions/development/contributions-debugging.md
Comment on lines +52 to +53
"provider": "youtube.com",
"href": "https://www.youtube.com/watch?v=zALr3zFIQJo"
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Note that this was not here before.

docs/markdown/Introduction/how-does-pants-work.md
Comment on lines -33 to -35
985,
635,
"#2f2f2f"
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Note that these were removed

docs/markdown/Introduction/how-does-pants-work.md
Comment on lines -54 to -56
783,
910,
"#2d2d2d"
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Note that these were removed

docs/markdown/Python/python-integrations/jupyter.md Outdated
Comment on lines 30 to 32
[block:image]
{
"images": [
{
"image": [
"https://files.readme.io/9f7ca19-jupyter-session.png",
"jupyter-session.png",
1446,
778,
"#f1f2f3"
],
"caption": ""
}
]
}
[/block] No newline at end of file

![](https://files.readme.io/9f7ca19-jupyter-session.png "jupyter-session.png")
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Note the change

docs/markdown/Python/python/python-interpreter-compatibility.md
Comment on lines -149 to -151
1499,
829,
"#cfd9ed"
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This was removed

docs/markdown/Using Pants/restricted-internet-access.md
@@ -83,22 +68,17 @@ See [Python third-party dependencies](doc:python-third-party-dependencies#custom

### JVM tools

Pants downloads the various JVM-related tools it uses from [Maven Central](), just as it does for your JVM code's dependencies.
Pants downloads the various JVM-related tools it uses from [Maven Central](<>), just as it does for your JVM code's dependencies.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Is this a bug?

@Eric-Arellano
Manual fixes
8da1429 
# Rust tests and lints will be skipped. Delete if not intended.
[ci skip-rust]

# Building wheels and fs_util will be skipped. Delete if not intended.
[ci skip-build-wheels]
kaos
kaos approved these changes Jun 16, 2022
View reviewed changes
Copy link
Member

@kaos kaos left a comment

Choose a reason for hiding this comment

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

Wow, this is huge. I hope you scripted the majority of these changes.. :P

I have not read through it all.. ;)

@Eric-Arellano
Copy link
Contributor Author

I hope you scripted the majority of these changes.. :P

I didn't because I felt it required manual review. I ended up manually reviewing both when doing the initial pass, and then I did a close review after.

I had TV on in the background hehe

I have not read through it all.. ;)

Are you comfortable with me landing this? I could split it up into multiple PRs, but that will still be a ton to manually review. It took me like 40 minutes to get through this all in the second audit :O

My thinking is that I still have to do the 2.12 and 2.13 audits, so I'll be able to catch any issues from there. Thanks to Git, we can see what things were beforehand.

@kaos
Copy link
Member

kaos commented Jun 16, 2022

Yeah, I'm not that concerned and being docs fixing mistakes are easy enough.

@Eric-Arellano Eric-Arellano merged commit 00e44d5 into pantsbuild:main Jun 16, 2022
@Eric-Arellano Eric-Arellano deleted the readable-markdown branch June 16, 2022 17:18
@stuhood
Copy link
Member

stuhood commented Jun 16, 2022

Unless this is cherry-picked to 2.11 and 2.12, this will make doc fixes harder to cherry-pick there. Not sure if that justifies reverting it, or just eagerly cherry-picking it to make sure we don't end up having trouble later.

@Eric-Arellano
Copy link
Contributor Author

Eric-Arellano commented Jun 16, 2022 •
edited
Loading

The plan is to cherry-pick to 2.11 and 2.12 :) I'm going to cherry-pick, then use Git tricks to know which pages diverge between 2.12 and 2.13 and manually fix those pages.

Edit: merge conflict is that fancy Git technology, hah. But I'm also going to audit independently what has changed via Git.

Eric-Arellano added a commit that referenced this pull request Jun 16, 2022
@Eric-Arellano
Use Readme.com's new Markdown syntax (Cherry-pick of #15845) (#15848)
f2c68cd 
Readme is migrating to a new editor, which uses a much more intuitive Markdown syntax than their old "raw mode". It is easier to read and renders better in Markdown renders.

Their `export` button used their old syntax in most places. So, I manually copied and pasted every page using their new editor to fix things.

This makes no content changes - only changes the syntax.

[ci skip-rust]
[ci skip-build-wheels]
Eric-Arellano added a commit that referenced this pull request Jun 16, 2022
@Eric-Arellano
Use Readme.com's new Markdown syntax (Cherry-pick of #15845) (#15851)
837434b 
Readme is migrating to a new editor, which uses a much more intuitive Markdown syntax than their old "raw mode". It is easier to read and renders better in Markdown renders.

Their `export` button used their old syntax in most places. So, I manually copied and pasted every page using their new editor to fix things.

This makes no content changes - only changes the syntax.

[ci skip-rust]
[ci skip-build-wheels]
illicitonion added a commit to illicitonion/pants that referenced this pull request Jun 17, 2022
@illicitonion
Bump to 2.13.0a0
fe5e790 
Internal changes:

* Add `@alonsodomin` to maintainers ([pantsbuild#15869](pantsbuild#15869))

* Scala parser improvements ([pantsbuild#15839](pantsbuild#15839))

* Refactor valid field aliases calculation for targets into a classmethod for easier re-use. ([pantsbuild#15861](pantsbuild#15861))

* Update Media page with Pycon ([pantsbuild#15852](pantsbuild#15852))

* Use Readme.com's new Markdown syntax ([pantsbuild#15845](pantsbuild#15845))

* [internal] better align test JVM lockfile support with pytest concepts ([pantsbuild#15804](pantsbuild#15804))

* Fix broken `engine_error` testutil decorator. ([pantsbuild#15818](pantsbuild#15818))

* Add `description_of_origin` for Docker address parsing ([pantsbuild#15814](pantsbuild#15814))

* Use `MultiGet` in Go rule ([pantsbuild#15838](pantsbuild#15838))

* Switch from warn to warning ([pantsbuild#15837](pantsbuild#15837))

* Bump clap from 3.1.18 to 3.2.4 in /src/rust/engine ([pantsbuild#15834](pantsbuild#15834))

* Bump reqwest from 0.11.10 to 0.11.11 in /src/rust/engine ([pantsbuild#15831](pantsbuild#15831))

* Bump strum from 0.24.0 to 0.24.1 in /src/rust/engine ([pantsbuild#15833](pantsbuild#15833))

* Bump strum_macros from 0.24.0 to 0.24.1 in /src/rust/engine ([pantsbuild#15835](pantsbuild#15835))

* Remove flake8-pantsbuild plugin ([pantsbuild#15830](pantsbuild#15830))

* go: support third-party package embeds ([pantsbuild#15827](pantsbuild#15827))

* Move `gshuflin` to Maintainers Emeritus ([pantsbuild#15828](pantsbuild#15828))

* Adds current contents of readme.com docs to repo and adds notes on how to sync. ([pantsbuild#15810](pantsbuild#15810))

* Remove unnecessary `WrappedNode` method indirection ([pantsbuild#15813](pantsbuild#15813))

* Handle anchors in doc_url() correctly. ([pantsbuild#15812](pantsbuild#15812))

* Move the macOS ARM64 build job into the existing test workflows. ([pantsbuild#15805](pantsbuild#15805))

* Add Lablup to users list. ([pantsbuild#15807](pantsbuild#15807))

* Add `description_of_origin` for several places finding Addresses ([pantsbuild#15797](pantsbuild#15797))

* [internal] Register `platform_specific_behavior` marker with Pytest ([pantsbuild#12679](pantsbuild#12679))

* Bump http from 0.2.7 to 0.2.8 in /src/rust/engine ([pantsbuild#15780](pantsbuild#15780))

* Update the `notify` crate. ([pantsbuild#15783](pantsbuild#15783))

* Bump tokio-stream from 0.1.8 to 0.1.9 in /src/rust/engine ([pantsbuild#15777](pantsbuild#15777))

* Bump indexmap from 1.8.1 to 1.8.2 in /src/rust/engine ([pantsbuild#15778](pantsbuild#15778))

* Bump uuid from 1.0.0 to 1.1.1 in /src/rust/engine ([pantsbuild#15779](pantsbuild#15779))

* Bump hyper from 0.14.18 to 0.14.19 in /src/rust/engine ([pantsbuild#15781](pantsbuild#15781))

* Update `crossbeam-utils` to `0.8.8`. ([pantsbuild#15782](pantsbuild#15782))
@illicitonion illicitonion mentioned this pull request Jun 17, 2022
Merged
illicitonion added a commit that referenced this pull request Jun 17, 2022
@illicitonion
Bump to 2.13.0a0 (#15871)
d1dd32a 
Internal changes:

* Add `@alonsodomin` to maintainers ([#15869](#15869))

* Scala parser improvements ([#15839](#15839))

* Refactor valid field aliases calculation for targets into a classmethod for easier re-use. ([#15861](#15861))

* Update Media page with Pycon ([#15852](#15852))

* Use Readme.com's new Markdown syntax ([#15845](#15845))

* [internal] better align test JVM lockfile support with pytest concepts ([#15804](#15804))

* Fix broken `engine_error` testutil decorator. ([#15818](#15818))

* Add `description_of_origin` for Docker address parsing ([#15814](#15814))

* Use `MultiGet` in Go rule ([#15838](#15838))

* Switch from warn to warning ([#15837](#15837))

* Bump clap from 3.1.18 to 3.2.4 in /src/rust/engine ([#15834](#15834))

* Bump reqwest from 0.11.10 to 0.11.11 in /src/rust/engine ([#15831](#15831))

* Bump strum from 0.24.0 to 0.24.1 in /src/rust/engine ([#15833](#15833))

* Bump strum_macros from 0.24.0 to 0.24.1 in /src/rust/engine ([#15835](#15835))

* Remove flake8-pantsbuild plugin ([#15830](#15830))

* go: support third-party package embeds ([#15827](#15827))

* Move `gshuflin` to Maintainers Emeritus ([#15828](#15828))

* Adds current contents of readme.com docs to repo and adds notes on how to sync. ([#15810](#15810))

* Remove unnecessary `WrappedNode` method indirection ([#15813](#15813))

* Handle anchors in doc_url() correctly. ([#15812](#15812))

* Move the macOS ARM64 build job into the existing test workflows. ([#15805](#15805))

* Add Lablup to users list. ([#15807](#15807))

* Add `description_of_origin` for several places finding Addresses ([#15797](#15797))

* [internal] Register `platform_specific_behavior` marker with Pytest ([#12679](#12679))

* Bump http from 0.2.7 to 0.2.8 in /src/rust/engine ([#15780](#15780))

* Update the `notify` crate. ([#15783](#15783))

* Bump tokio-stream from 0.1.8 to 0.1.9 in /src/rust/engine ([#15777](#15777))

* Bump indexmap from 1.8.1 to 1.8.2 in /src/rust/engine ([#15778](#15778))

* Bump uuid from 1.0.0 to 1.1.1 in /src/rust/engine ([#15779](#15779))

* Bump hyper from 0.14.18 to 0.14.19 in /src/rust/engine ([#15781](#15781))

* Update `crossbeam-utils` to `0.8.8`. ([#15782](#15782))
This was referenced Jun 23, 2022
Merged
Merged
@wisechengyi wisechengyi mentioned this pull request Jun 25, 2022
Merged
wisechengyi added a commit that referenced this pull request Jun 26, 2022
@wisechengyi
Prepare 2.14.0.dev0 (#15944)
9355d6e 
### Internal (put these in a PR comment for review, not the release notes)

* Bump uuid from 1.1.1 to 1.1.2 in /src/rust/engine ([#15832](#15832))

* Tests for Docker from arg not a upstream target ([#15874](#15874))

* Fix outstanding todo for moved fields defaults support. ([#15923](#15923))

* Move generic debug adapter settings to dedicated subsystem ([#15928](#15928))

* Prepare `2.12.0rc3`. ([#15913](#15913))

* Prepare `2.11.1rc3`. ([#15912](#15912))

* Upgrade default mypy to 0.961 and default pylint to v2.13.9 ([#15886](#15886))

* Bump clap from 3.2.4 to 3.2.6 in /src/rust/engine ([#15909](#15909))

* Bump indexmap from 1.8.2 to 1.9.1 in /src/rust/engine ([#15894](#15894))

* Bump time from 0.3.9 to 0.3.11 in /src/rust/engine ([#15895](#15895))

* Bump tower-service from 0.3.1 to 0.3.2 in /src/rust/engine ([#15896](#15896))

* Bump crossbeam-channel from 0.5.4 to 0.5.5 in /src/rust/engine ([#15893](#15893))

* [internal] remove TestCoursierWrapper ([#15902](#15902))

* Silence `[scala-infer].force_add_siblings_as_dependencies` deprecation. ([#15898](#15898))

* Add unit tests to GraphQL queries ([#15792](#15792))

* Release script fixups ([#15875](#15875))

* [internal] jvm: port remaining tests to use test lockfiles ([#15870](#15870))

* Bump to 2.13.0a0 ([#15871](#15871))

* Add `@alonsodomin` to maintainers ([#15869](#15869))

* Scala parser improvements ([#15839](#15839))

* Refactor valid field aliases calculation for targets into a classmethod for easier re-use. ([#15861](#15861))

* Update Media page with Pycon ([#15852](#15852))

* Use Readme.com's new Markdown syntax ([#15845](#15845))

* [internal] better align test JVM lockfile support with pytest concepts ([#15804](#15804))

* Fix broken `engine_error` testutil decorator. ([#15818](#15818))

* Add `description_of_origin` for Docker address parsing ([#15814](#15814))

* Use `MultiGet` in Go rule ([#15838](#15838))

* Switch from warn to warning ([#15837](#15837))

* Bump clap from 3.1.18 to 3.2.4 in /src/rust/engine ([#15834](#15834))

* Bump reqwest from 0.11.10 to 0.11.11 in /src/rust/engine ([#15831](#15831))

* Bump strum from 0.24.0 to 0.24.1 in /src/rust/engine ([#15833](#15833))

* Bump strum_macros from 0.24.0 to 0.24.1 in /src/rust/engine ([#15835](#15835))

* Remove flake8-pantsbuild plugin ([#15830](#15830))

* go: support third-party package embeds ([#15827](#15827))

* Move `gshuflin` to Maintainers Emeritus ([#15828](#15828))

* Adds current contents of readme.com docs to repo and adds notes on how to sync. ([#15810](#15810))

* Remove unnecessary `WrappedNode` method indirection ([#15813](#15813))

* Handle anchors in doc_url() correctly. ([#15812](#15812))

* Move the macOS ARM64 build job into the existing test workflows. ([#15805](#15805))

* Add Lablup to users list. ([#15807](#15807))

* Add `description_of_origin` for several places finding Addresses ([#15797](#15797))

* [internal] Register `platform_specific_behavior` marker with Pytest ([#12679](#12679))

* Bump http from 0.2.7 to 0.2.8 in /src/rust/engine ([#15780](#15780))

* Update the `notify` crate. ([#15783](#15783))

* Bump tokio-stream from 0.1.8 to 0.1.9 in /src/rust/engine ([#15777](#15777))

* Bump indexmap from 1.8.1 to 1.8.2 in /src/rust/engine ([#15778](#15778))

* Bump uuid from 1.0.0 to 1.1.1 in /src/rust/engine ([#15779](#15779))

* Bump hyper from 0.14.18 to 0.14.19 in /src/rust/engine ([#15781](#15781))

* Update `crossbeam-utils` to `0.8.8`. ([#15782](#15782))
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@kaos kaos kaos approved these changes

@stuhood stuhood Awaiting requested review from stuhood

@chrisjrn chrisjrn Awaiting requested review from chrisjrn

Assignees
No one assigned
Labels
category:internal CI, fixes for not-yet-released features, etc.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@Eric-Arellano @kaos @stuhood