docs: add the first tutorial on writing plugins to readme docs directory #17930
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
AlexTereshenkov
commented
Jan 5, 2023
| @@ -1,9 +1,399 @@ | |||
| --- | |||
| title: "Create a new goal" | |||
| slug: "create-a-new-goal" | |||
| hidden: True | |||
| excerpt: "Getting started writing plugins for Pants by creating a new goal." | |||
| hidden: false | |||
There was a problem hiding this comment.
I've made it visible, I believe this is what we want to do now that I've got the content?
| @@ -1,9 +1,399 @@ | |||
| --- | |||
| title: "Create a new goal" | |||
| slug: "create-a-new-goal" | |||
| hidden: True | |||
| excerpt: "Getting started writing plugins for Pants by creating a new goal." | |||
There was a problem hiding this comment.
Added an excerpt; assuming it's something that can come from the .md file and doesn't have to exist in the readme.com beforehand.
| createdAt: "2022-02-07T05:44:28.620Z" | ||
| updatedAt: "2022-02-07T05:44:28.620Z" | ||
| --- | ||
| In this tutorial, you'll learn the basics needed to get started writing a plugin. You will create a new goal, `project-version`, which will tell you the version (retrieved from the `VERSION` text file) of a particular project in your monorepository. You will learn how to create a new custom target to refer to the `VERSION` file, how to author a new goal, and, most importantly, how to connect rules and targets. |
There was a problem hiding this comment.
The rest is copy/paste from the original file that is now removed. Only updated the headers from ## to ### as I can see the readme.com has fairly large font for header 2.
kaos
approved these changes
Jan 5, 2023
cczona
pushed a commit
to cczona/pants
that referenced
this pull request
Jan 9, 2023
…ory (pantsbuild#17930) Add the first tutorial on writing plugins to readme docs directory
AlexTereshenkov
added a commit
that referenced
this pull request
Jan 27, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Benjy has created a page for me in readme.com. This PR moves the file I had in markdown to this very page.