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

Added blog post submission instructions #221

Merged
merged 3 commits into from
Oct 25, 2024

Conversation

Jurj-Bogdan
Copy link
Contributor

Q A
Documentation yes
RFC yes

Description

Added blog post submission instructions, as mentioned in #197. Let me know of any issues or extra sections that should be added

(issue 197)

Signed-off-by: Jurj-Bogdan <[email protected]>
(issue 197)

Signed-off-by: Jurj-Bogdan <[email protected]>
README.md Outdated Show resolved Hide resolved
@froschdesign
Copy link
Member

An important part is missing from the content: Who is allowed to write blog posts?

@arhimede
Copy link
Member

@froschdesign Here we have the answer to the question how
Probably the question who can be answered after a TSC discussion, but I think anyone can submit a PR with a blog article. If will be accepted or not, that's another story

@froschdesign
Copy link
Member

@arhimede

Here we have the answer to the question how

If only the how is explained here, we need to add two links in the list view. That cannot be the goal.

ADD_BLOG_ENTRY.md Outdated Show resolved Hide resolved
- If submitting for the first time an [author](#blog-author) YAML file must be added to the `data/blog/authors` directory.
- Add an MD file containing the [blog post's metadata and body](#blog-post-content).
- each file must be added in the current year's directory, found in `data/blog/`.

Choose a reason for hiding this comment

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

I suggest that you state the filename convention yyyy-mm-dd-title with an example

@visto9259
Copy link

@Jurj-Bogdan has provided instructions to create the post and author files and in which folder which is great.
I think we are missing instructions that mentions that blog entries are submitted via a PR to the repo.
And the PR will go through the review, approval and publish process as would any contributions.

In my opinion, anyone should be welcomed to submit a blog entry in the same way anyone can submit a PR to any repo. PRs are revview and approved (or rejected).

What we may need are some guidelines as to what a blog post should contain or not.

Copy link

@visto9259 visto9259 left a comment

Choose a reason for hiding this comment

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

I am good with this.
Thanks

@Jurj-Bogdan
Copy link
Contributor Author

@froschdesign @arhimede @visto9259 I ran into a potential issue after checking the linting command from the CI pipeline - only the README.md file is being linted. Should it be extended to include the blog entries and author yaml files as well?

@visto9259
Copy link

visto9259 commented Oct 24, 2024

I ran into a potential issue after checking the linting command from the CI pipeline - only the README.md file is being linted. Should it be extended to include the blog entries and author yaml files as well?

I am not sure that I can make the call here. I would suggest to open a separate issue (RFC) to start a discussion on adding linting blog entries and author files to the CI pipeline so that we can close this PR for now.

@froschdesign @arhimede any thoughts?

@arhimede arhimede merged commit 018743b into laminas:staging Oct 25, 2024
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants