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

docs: make tutorials to get started writing plugins visible on readme pages #18083

Conversation

AlexTereshenkov
Copy link
Member

@AlexTereshenkov AlexTereshenkov commented Jan 24, 2023

Make all writing plugins tutorials visible on readme.com

@@ -1,8 +1,8 @@
---
title: "Advanced plugin concepts"
slug: "advanced plugin concepts"
slug: "advanced-plugin-concepts"
Copy link
Member Author

Choose a reason for hiding this comment

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

I think the slug is supposed to have dashes, so adding them

@@ -1,7 +1,7 @@
---
title: "Create a new goal"
slug: "create-a-new-goal"
excerpt: "Getting started writing plugins for Pants by creating a new goal."
excerpt: "Getting started writing plugins for Pants by creating a new goal"
Copy link
Member Author

Choose a reason for hiding this comment

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

Removing the dot to make consistent with the rest of the tutorials.

Copy link
Member

Choose a reason for hiding this comment

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

To me a well formed sentence ends with a period. Maybe add the missing period on the other excerpts instead?

@AlexTereshenkov AlexTereshenkov marked this pull request as ready for review January 24, 2023 23:14
@AlexTereshenkov AlexTereshenkov merged commit 0e6d38f into pantsbuild:main Jan 26, 2023
@AlexTereshenkov AlexTereshenkov deleted the docs/make-writing-plugins-tutorials-pages-visible branch January 26, 2023 16:24
@AlexTereshenkov AlexTereshenkov added this to the 2.15.x milestone Jan 27, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants