Project

Profile

Help

Task #2249

Document platform Django app layout

Added by bmbouter about 3 years ago. Updated 6 months ago.

Status:
MODIFIED
Priority:
Normal
Assignee:
Category:
-
Sprint/Milestone:
Start date:
Due date:
% Done:

100%

Platform Release:
Blocks Release:
Backwards Incompatible:
No
Groomed:
Yes
Sprint Candidate:
Yes
Tags:
QA Contact:
Complexity:
Smash Test:
Verified:
No
Verification Required:
No
Sprint:
Sprint 18

Description

The Pulp developer documentation needs to be updated for 3.0. This should include:

These should go in the platform developer docs
  • The location and organization of the pulp.app Django application
  • How the settings.py file uses entry points to install a plugin's django app in INSTALLED_APPS
  • How we use Django for discovery of models and migrations for the platform and all apps
These should go in the plugin developer docs
  • How each plugin is also a Django app
  • How plugins should only import from pulp.plugins

A lot of details can be found in the thread this message0 starts.

[0]: https://www.redhat.com/archives/pulp-dev/2016-September/msg00000.html


Related issues

Blocked by Pulp - Task #2454: Stub File Plugin MODIFIED Actions

Associated revisions

Revision bbcdb7c3 View on GitHub
Added by semyers over 2 years ago

Docs for application and plugin layouts and structure

closes #2249
https://pulp.plan.io/issues/2249

Revision bbcdb7c3 View on GitHub
Added by semyers over 2 years ago

Docs for application and plugin layouts and structure

closes #2249
https://pulp.plan.io/issues/2249

Revision bbcdb7c3 View on GitHub
Added by semyers over 2 years ago

Docs for application and plugin layouts and structure

closes #2249
https://pulp.plan.io/issues/2249

History

#1 Updated by amacdona@redhat.com about 3 years ago

  • Tracker changed from Issue to Task
  • % Done set to 0

#2 Updated by semyers about 3 years ago

  • Groomed changed from No to Yes
  • Sprint Candidate changed from No to Yes

I think this is worth doing sooner rather than later, particularly since the "file" plugin is likely to be created soon.

#3 Updated by bmbouter about 3 years ago

+1 to doing this soon.

#4 Updated by mhrivnak almost 3 years ago

  • Sprint/Milestone set to 29

#5 Updated by mhrivnak almost 3 years ago

Either in this task, or another, we need docs about the rest of the pulp 3 code layout. Yesterday some of us were trying to understand the intent and expectation behind pulp.tasking, and it would have been very helpful to have that documented.

#6 Updated by mhrivnak almost 3 years ago

  • Sprint/Milestone changed from 29 to 30

#7 Updated by mhrivnak over 2 years ago

  • Sprint/Milestone changed from 30 to 36

#8 Updated by semyers over 2 years ago

  • Status changed from NEW to ASSIGNED
  • Assignee set to semyers

As might be expected, my work for #2454 intersects with this issue. Some of the documentation I did in that issue is usable here, so I'll pick this up and get it baked into the 3.0 docs.

#9 Updated by semyers over 2 years ago

#10 Updated by semyers over 2 years ago

I added a blocking relationship on #2454, since the file plugin is effectively the proof of these docs. It's likely that any changes made in the review of that issue will affect what gets written into these docs, so I think we need #2454 to be MODIFIED or better before we can adequately review docs changes related to this issue.

#11 Updated by semyers over 2 years ago

#2454 is now MODIFIED, I'll be getting my docs PR up for review soon.

#12 Updated by mhrivnak over 2 years ago

  • Sprint/Milestone changed from 36 to 37

#13 Updated by semyers over 2 years ago

  • Status changed from ASSIGNED to POST

#14 Updated by semyers over 2 years ago

As mentioned in the PR, I ran into some issues with sphinx linking, particularly when sphinx is left to its own devices to create links, such as when generating a link to a given class's base class. I have some ideas about how to get sphinx playing along with the import strategy that we're using to organize things like models, serializers, and viewsets that are predicated on acceptance of my POSTed PR. I think it's possible to improve sphinx's crossref behavior a little bit to be smarter about the links it generates based on how our app is structure, and plan to capture those thoughts in a story if this goes MODIFIED in its current state.

#15 Updated by semyers over 2 years ago

  • Status changed from POST to MODIFIED
  • % Done changed from 0 to 100

#16 Updated by bmbouter over 1 year ago

  • Sprint set to Sprint 18

#17 Updated by bmbouter over 1 year ago

  • Sprint/Milestone deleted (37)

#18 Updated by daviddavis 6 months ago

  • Sprint/Milestone set to 3.0

#19 Updated by bmbouter 6 months ago

  • Tags deleted (Pulp 3)

Please register to edit this issue

Also available in: Atom PDF