pulp / pulp/pulpcore

Mention upload objects are only for in progress uploads

Open
#2,060 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Documentation Task Wishlist
Dominant language
Python
Stars
598
Forks
168
Avg merge
1d 4h
Merged PRs (30d)
86

Description

Author: @gerrod3 (gerrod)

Redmine Issue: 9501, https://pulp.plan.io/issues/9501


Docs should mention that the upload objects are for current file uploads happening in Pulp right now, and are subject to being deleted after the upload is complete.

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

Locate the pulpcore documentation that describes upload objects and read the surrounding lifecycle text. Update the relevant documentation to explain that these objects represent uploads currently in progress and may be deleted after completion; done means the lifecycle is clear to readers.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.