Closed Bug 1332882 Opened 7 years ago Closed 7 years ago

Title does not fit style guide

Categories

(developer.mozilla.org Graveyard :: General, enhancement, P5)

Product:
developer.mozilla.org Graveyard
Component:
General
Platform:
All
Other
Type:
enhancement

Tracking

(Not tracked)

Status:
RESOLVED FIXED

People

(Reporter: ptudan, Assigned: tckooll, Mentored)

References

(
URL
)

Details

(Keywords: in-triage) 

:: Developer Documentation Request

      Request Type: Correction
     Gecko Version: unspecified
 Technical Contact: 

:: Details

I find it quite ironic that the title of the "Articles in need of review tagged: editorial" does not fit the MDN style guide.  This page can't be edited by users, to my knowledge.
Product: Developer Documentation → Mozilla Developer Network
Because it's not sentence case, you mean? Yes, we should fix this, and as you say it can't be edited in the wiki, it needs to be fixed in Kuma. I think it just means fixing this file: https://github.com/mozilla/kuma/blob/master/kuma/wiki/jinja2/wiki/list/needs_review.html to have the correct case.
Agreed, it's a two line fix (line 12 and line 14).  Some translators have already fixed it:

https://developer.mozilla.org/fr/docs/needs-review/editorial

I'd drop 'tagged' from first the phrase:

Articles in need of review: %(tag)s

Second phrase should just get sentence case:

All articles in need of review

Leaving it mentored for the easy first contribution.
Mentor: jwhitlock
Status: UNCONFIRMED → NEW
Ever confirmed: true
Severity: normal → enhancement
Keywords: in-triage
Hi, I would like to take on this bug. I am a beginner so this looks like a good, simple bug for me to work on.
Timothy - I've assigned the bug to you, please let me know if you need help or if you can no longer work on it.
Assignee: nobody → tckooll
Thanks! Could you show me where the styleguide is?
Thanks! And now I'm having some issues setting up the Kuma repo. I've been following the kuma installation docs here https://kuma.readthedocs.io/en/latest/installation.html. I can't seem to run "docker exec -i kuma_web_1 make localecompile" or "docker exec -i kuma_web_1 make build-static" because I get permission denied errors, which is weird because it looks like I have the proper permissions. I've already tried sudo and it still doesn't work. Here's a full stacktrace:

$ sudo docker exec -i kuma_web_1 make localecompile
cd locale; ./compile-mo.sh .
./ee/LC_MESSAGES/promote-mdn.po:4: warning: header field 'PO-Revision-Date' still has the initial default value
./ee/LC_MESSAGES/promote-mdn.po:4: warning: header field 'Last-Translator' still has the initial default value
msgfmt: error while opening "./ee/LC_MESSAGES/promote-mdn.mo" for writing: Permission denied
Makefile:72: recipe for target 'localecompile' failed
make: *** [localecompile] Error 1

Thanks for the help and do you know what the issue is?
It sounds like you are using Linux. The instructions were written by a MacOS user (me), and Docker for Mac takes care of user issues.  On Linux, you need to set the user ID that you run commands as.

This may work:

docker-compose exec web make localecompile

Or this:

docker-compose run --rm --user $(id -u) web make localecompile
Status: NEW → ASSIGNED
Yea I'm on Linux. And thanks! The second command worked
Hmmm. Maybe it didn't work after all. I get a 500 error when I go to localhost:8000. Looks like maybe gulp isn't serving the files?
Sorry that the setup isn't going smoothly.  I'm looking into options for running Linux so I can duplicate these issues and update the documentation.
That's alright. Thanks for the help. let me know if there's anything I can do to help you
I've tried out installing Kuma in a fresh Ubuntu 16.04 install, and I've updated the install instructions.  They need to be reviewed and merged before they are official, but you might want to try them out:

https://github.com/mozilla/kuma/pull/4130
https://github.com/mozilla/kuma/blob/b1d111be96b7bd6802c87be00a3169d3ec4527e3/docs/installation.rst

The key part for you may be adding a .env file with UID set to your local user's ID, like this:

$ echo "UID=$UID" >> .env
Great! Thanks John. I'll try it out. If it works, I'll have the patch in shortly after
K I've implemented the fix and tested it. I'm just not sure how to run the automatic tests and convert my changes to a patch file. 

Also, thanks for the new instructions! I tried it out from the beginning again and they work. I did have to use sudo for all of the docker-compose commands though.
The diff looks good to me. We don't use Bugzilla-attached patches for Kuma. Please open a pull request on GitHub, and we'll do the code review there.
Alright. Done. I'm assuming it goes into master? 
https://github.com/mozilla/kuma/pull/4141
Yes, PRs are merged to master, and you did it correctly. Thanks!
Commit pushed to master at https://github.com/mozilla/kuma

https://github.com/mozilla/kuma/commit/9a52b3cd1272e1d69026ecd7e9e49f70731d0ba6
Merge pull request #4141 from Tckool/fix-title

Bug 1332882 Fix capitalization for Articles in need of review page
The code looks good, and TravisCI was happy, so I merged the code to master.  We'll probably push this to stage and production next week, and I'll close the bug when it is live in production.
Great! Thanks for all the help! Oh yea. One more thing I forgot to mention about the linux instructions is that the new instructions worked but I wasn't able to load the assets. So I only had the plain html on the page, but for this, that was sufficient to test it anyways.
It looks like I'll need a Linux box to fully test out the instructions, but that's a different bug. Code pushed to stage and production, so closing this one as fixed. Thanks again, Timothy!
Status: ASSIGNED → RESOLVED
Closed: 7 years ago
Resolution: --- → FIXED
Product: developer.mozilla.org → developer.mozilla.org Graveyard
You need to log in before you can comment on or make changes to this bug.