Skip to content

Update README.rst#302

Merged
jacobtylerwalls merged 4 commits into
django:mainfrom
kehach07:patch-1
Jun 26, 2026
Merged

Update README.rst#302
jacobtylerwalls merged 4 commits into
django:mainfrom
kehach07:patch-1

Conversation

@kehach07

Copy link
Copy Markdown
Contributor

Update README static asset paths and Docker SCSS commands for local Trac setup

Comment thread README.rst Outdated
``cp -rT ../djangoproject.com/static/js trac-env/htdocs/js``
4. Compile trackhacks.scss:
``make compile-scss``
``cp -rT ../djangoproject.com/djangoproject/static/js trac-env/htdocs/js``

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

The T option didn't worked for me, did it worked for you like that @kehach07 ?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Hi @sabderemane,

Yes, it worked on my setup. I believe the -rT option was already present before my changes, so I kept it as is.

From what I understand, -T treats the destination as a normal path instead of creating an additional nested directory. If -T is not working on your environment, we could use an alternative such as:

cp -r ../djangoproject.com/djangoproject/static/js/* trac-env/htdocs/js/

or

cp -r ../djangoproject.com/djangoproject/static/js/. trac-env/htdocs/js/

which should copy the contents into the destination directory without relying on the -T flag.

Let me know what you think.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Great! I think we could stick to the first one, technically we don't have any dot files in the js folder to copy so worth to stick to the first command.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

thanks , i will update that

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

@sabderemane Hi, I’ve made the requested changes. Please let me know if anything else is required.

@sabderemane sabderemane left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM, thank you Keha!

@sabderemane

Copy link
Copy Markdown
Member

hello @django/ops-team could someone review this PR by any chance?

@jacobtylerwalls jacobtylerwalls linked an issue Jun 24, 2026 that may be closed by this pull request

@jacobtylerwalls jacobtylerwalls left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thank you for sprucing this up! I also struggled, maybe you can help me?

Comment thread README.rst Outdated
Comment on lines +62 to +64
4. Compile trachacks.scss::
docker compose exec trac make compile-scss
docker compose restart trac

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

For my own understanding, is the equivalent non-docker command the one given above under the last bullet in "Local install"? (And if so, can we refer there somehow?)

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

You are spot on, Jacob! That Docker command does the exact same thing as the local setup.

To save anyone from scrolling back to the top of the file to hunt for it, I've updated this step to include the direct, standalone sassc alternative right here in line. Thanks for catching that!

Comment thread README.rst Outdated
``cp ../djangoproject.com/static/scss/_utils.scss scss/``
``cp ../djangoproject.com/djangoproject/static/css/*.css trac-env/htdocs/css/``
2. Copy _utils.scss (needed by trachacks.scss):
``cp ../djangoproject.com/djangoproject/static/scss/_utils.scss scss/``

@jacobtylerwalls jacobtylerwalls Jun 24, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I must be missing an important step, because I don't have any ../djangoproject.com/djangoproject/static/scss directory. What did I forget?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Ah, great eyes! You didn't forget a step at all.

The scss folder isn't actually inside the static folder—they are sitting side-by-side as sibling directories inside the inner djangoproject wrapper. I've updated the README to reflect the exact file tree path: ../djangoproject.com/djangoproject/scss/_utils.scss.

kehach07 added 2 commits June 26, 2026 09:20
docs: resolve pull request feedback by updating scss paths and inline compilation scripts
docs: resolve pull request feedback by updating scss paths and inline compilation scripts

@jacobtylerwalls jacobtylerwalls left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thanks 👍

@jacobtylerwalls jacobtylerwalls merged commit ca9f928 into django:main Jun 26, 2026
5 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.

Update README static asset paths for local Trac setup

3 participants