pulp / pulp/pulp-docs

As a user, I want to be able to share and see community Pulp scripts

Open
#86 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
HTML
Stars
2
Forks
17
Avg merge
7d 18h
Merged PRs (30d)
3

Description

Initially posted here:

Somewhat related, does the Pulp project have a repository of admin/user scripts anywhere that people can contribute to? I wrote up a Python script to do the cleanup described here, might be useful to others.

And further discussed in pulpcore meeting (10 sep 2024) with the following consesus:

  • users can post to discourse first
  • have a section 'somewhere' ("Utility Scripts"?) in docs for "list of user script links"
  • we can pull things in to such a section as they show up?

Considerations

There are a lot of possible ways to make this. From the pulp-docs perspective, its possible to pull such a list from various places and formats, if that is a desired goal.

I think it's worth exploring some different kind of options for this. Some key aspects are:

  • User submission and acceptance workflow
  • Presentation form
  • Discoverability
  • Ease of implementation

Let's share some proposals here.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the linked pulp_container discussion and the 10 Sep 2024 pulpcore meeting consensus. Explore how user submissions, acceptance, presentation, discoverability, and implementation could work in pulp-docs. Done requires a decided proposal for a Utility Scripts section or another documented approach.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.