-
-
Notifications
You must be signed in to change notification settings - Fork 636
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
Adds current contents of readme.com docs to repo and adds notes on how to sync. #15810
Conversation
# 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]
# 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]
# 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]
# 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]
# 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]
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Awesome! It would be good to link to the design doc motivating this change https://docs.google.com/document/d/1bZE8PlF9oRzcPQz4-JUFr5vfD0LFHH4V3Nj2k221CFM/edit
@@ -0,0 +1,2 @@ | |||
node_modules |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This won't show up in pants_ignore by default, but we probably want Pants to ignore it. Should probably add to pants.toml
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good idea.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
(changes applied)
# Rust tests and lints will be skipped. Delete if not intended. [ci skip-rust]
Currently the rdme process is manual, until we bed down the process, at which point we'll add it to CI. | ||
|
||
The motivation for in-repo docs is covered [on this Google doc](https://docs.google.com/document/d/1bZE8PlF9oRzcPQz4-JUFr5vfD0LFHH4V3Nj2k221CFM/view) | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Any way to "preview" changes locally?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not by using Readme, unfortunately. We've identified future work in migrating to Sphinx, which will allow you to generate your own local docs, but that's not possible now.
Given the docs are common markdown, most markdown rendering tools should look fine. If you want to see it on readme's site, it should be possible for you to create your own scratch readme account and sync the docs up to that. The tools are reasonably self-contained.
…w to sync. (pantsbuild#15810) Per discussion, this is the first in a series of docs updates that will allow us to manage Pants' canonical docs from inside our repo. The markdown files are a copy of `v2.12` from `readme.com`. Once accepted, these docs will be synced up to `readme.com` as `v2.13`. I will then create new versions of this PR against the 2.12 and 2.11 release branches, containing the docs from those versions on readme.com. Addresses pantsbuild#15811 (cherry picked from commit f2ea5c7) # Rust tests and lints will be skipped. Delete if not intended. [ci skip-rust]
…w to sync. (pantsbuild#15810) Per discussion, this is the first in a series of docs updates that will allow us to manage Pants' canonical docs from inside our repo. The markdown files are a copy of `v2.12` from `readme.com`. Once accepted, these docs will be synced up to `readme.com` as `v2.13`. I will then create new versions of this PR against the 2.12 and 2.11 release branches, containing the docs from those versions on readme.com. Addresses pantsbuild#15811 (cherry picked from commit f2ea5c7) # Rust tests and lints will be skipped. Delete if not intended. [ci skip-rust]
|
||
> 📘 When will your change be released? | ||
> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Oh, interesting. This looks like an alternative to the block
syntax?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Right, this is Readme's new preferred syntax for blocks -- markdown blockquote syntax, with a leading emoji to indicate which sort of block it is.
…w to sync. (Cherry-picks #15810) (#15820) Per discussion, this is the first in a series of docs updates that will allow us to manage Pants' canonical docs from inside our repo. The markdown files are a copy of `v2.12` from `readme.com`. Addresses [#15811](https://github.com/chrisjrn/pants/issues/15811)
…w to sync. (Cherry-picks #15810) (#15821) Per discussion, this is the first in a series of docs updates that will allow us to manage Pants' canonical docs from inside our repo. The markdown files are a copy of `v2.11` from `readme.com`. Addresses [#15811](https://github.com/chrisjrn/pants/issues/15811)
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))
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))
### 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))
Per discussion, this is the first in a series of docs updates that will allow us to manage Pants' canonical docs from inside our repo. The markdown files are a copy of
v2.12
fromreadme.com
.Once accepted, these docs will be synced up to
readme.com
asv2.13
. I will then create new versions of this PR against the 2.12 and 2.11 release branches, containing the docs from those versions on readme.com.Addresses #15811