-
Notifications
You must be signed in to change notification settings - Fork 154
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
Redesign codebase prep #13546
Draft
robdivincenzo
wants to merge
40
commits into
main
Choose a base branch
from
TP1-1991-redesign-codebase-prep
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Redesign codebase prep #13546
+6,087
−4,836
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ed0f4e9
to
3ed8f7e
Compare
Closed
4ba864a
to
848df91
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR re-organizes the codebase to prep for redesign. The goal is to organize the "upstream"
main
branch without interruption of the site. At a high level, it does the following:network-api
into a useful Django project directory namedfoundation_cms
networkapi
into a simple "namespace" directory namedlegacy_apps
to house the legacy appsfoundation_cms
, this is simply a home for the legacy apps' code.manage.py
to the root directorycd
intonetwork-api
to run (or appendingnetwork-api
to the python command like in Heroku Scheduler (i.e.python network-api/manage.py sync_locale_trees
)root/network-api/networkapi/app1
, it will beroot/foundation_cms/app1
settings.py
into asettings
app.settings.py
was moved to abase.py
to serve as the base settings. In the longrun, this could help us to better simplify and distribute settings for various environments, instead of having everything in one file with several conditionalif
statements./source/
andfrontend/
(compiled files) into relevant Django project folders (foundation_cms/static/ for new files) and (foundation_cms/legacy_apps/static/ for the legacy files). This should streamline development because the static assets are closer to where developers are modifying templates, whereas there was a large separation previously. Organizing the frontend assets into astatic/
directory is also a Django convention and should make more sense in general./foundation_cms/legacy_apps/static/
is the new directory for legacy source files (formerly/source/
)./foundation_cms/legacy_apps/static/compiled
is the new directory for those compiled source files (formerlynetwork-api/networkapi/frontend
)./foundation_cms/static/
/media/
and/staticfiles/
are collected in the project root folder now, alongsidemanage.py
.package.json
scripts into separate commands for legacy and main.Link to sample test page: https://foundation-s-tp1-1991-r-v2rggk.mofostaging.net/en/
Related PRs/issues: #
Launch Notes
network-api
is no longer needed to runmanage.py
commands.Checklist
Tests
Changes in Models:
Documentation:
Merge Method
💡❗Remember to use squash merge when merging non-feature branches into
main
┆Issue is synchronized with this Jira Story