Opened 4 years ago

Last modified 13 months ago

#5429 review defect

Update documentation to reflect changes to mediagoblin.ini

Reported by: ayleph Owned by:
Priority: minor Milestone: 0.10.0
Component: documentation Keywords: bitesized
Cc: Parent Tickets:

Description

The latest documentation still recommends copying mediagoblin.ini to mediagoblin_local.ini. This is now deprecated as we no longer ship mediagoblin.ini, and we instead recommend copying mediagoblin.example.ini to mediagoblin.ini. The documentation should be updated to reflect this.

Subtickets

Attachments (5)

0001-Fix-for-issue-5429.patch (1.6 KB) - added by Saksham Agrawal 4 years ago.
0002-Second-fix-for-the-issue-5429.patch (14.5 KB) - added by Saksham Agrawal 4 years ago.
0003-Fix-gor-issue-5429.patch (1.1 KB) - added by Saksham Agrawal 4 years ago.
0004-Fix-for-issue-5429.patch (11.8 KB) - added by Saksham Agrawal 4 years ago.
remove-local.patch (1.7 KB) - added by dpg 22 months ago.
Little confused. It seems the online documentation just needs synced with the master branch?

Download all attachments as: .zip

Change History (19)

comment:1 Changed 4 years ago by Saksham Agrawal

Hello

I would like to work on this ticket. It will be my first one, so can you please help me out how to submit a patch

comment:2 Changed 4 years ago by ayleph

I forgot that make will automatically copy mediagoblin.example.ini to mediagoblin.ini if the file doesn't already exist. So we don't require that the user perform this step themselves, but we do allow it. The part about mediagoblin_local.ini still needs to be removed though.

comment:3 in reply to:  1 Changed 4 years ago by ayleph

Replying to saksham1115:

Hello

I would like to work on this ticket. It will be my first one, so can you please help me out how to submit a patch

Sure! We usually do development on the master branch and submit patches in git-format-patch format. If you want to submit a patch, you should make sure you're up to date with master.

$ cd /path/to/mediagoblin
$ git checkout master
$ git pull

Personally, I like to then create a working branch based off of master for each issue. I do that like this.

$ git checkout -b issue5429

Then apply your changes. When you're finished, you need to export your changes in git-format-patch format. If you're working on a separate branch, you can export your changes from master like this. If you made multiple commits, you might want to squash them into a single commit below running the command below.

$ git format-patch master

Check the patch file(s) and make sure they look good. Also make sure they contain the correct attribution information for you (your preferred name/nickname and email address).

Once you have a patch ready, upload it to here using the Attachments button on this issue. Then change the ticket status to "review." It also helps if you contact someone on IRC to let them know you have a patch ready for review. If there are issues with the patch or if someone needs more information, they'll respond to the ticket.

Edit: Also, if you're working on a ticket, you can claim the ticket to mark it as in-progress.

Last edited 4 years ago by ayleph (previous) (diff)

comment:4 Changed 4 years ago by ayleph

Keywords: bitesized added
Priority: majorminor

Changed 4 years ago by Saksham Agrawal

comment:5 Changed 4 years ago by Saksham Agrawal

Status: newreview

comment:6 Changed 4 years ago by ayleph

Thanks for the patch. There are a few more files that reference mediagoblin_local.ini and it would be good to fix them all at once. I see the following files still refer to mediagoblin_local.ini. The one exception below is relnotes.rst, as that file is simply a collection of historical release notes.

docs/source/siteadmin/configuration.rst
docs/source/siteadmin/deploying.rst
docs/source/siteadmin/media-types.rst
docs/source/siteadmin/production-deployments.rst
docs/source/siteadmin/relnotes.rst
docs/source/siteadmin/theming.rst

Also, there are some old typos in the file you changed that would be good to fix.

- To enable a media type, add the the media type under the ``[plugins]`` section 
- in you ``mediagoblin.ini``. For example, if your system supported image
+ To enable a media type, add the media type under the ``[plugins]`` section in
+ your ``mediagoblin.ini``. For example, if your system supports image

Changed 4 years ago by Saksham Agrawal

Changed 4 years ago by Saksham Agrawal

comment:7 Changed 4 years ago by Saksham Agrawal

I am extremely sorry for the typos. I didn't see the exception for the relnotes. Patch file 0003 has the fix for the typos. Please don't use the 0002 patch file as i have by mistake changed the relnotes. Will fix it ASAP and upload the new patch file.

Last edited 4 years ago by Saksham Agrawal (previous) (diff)

Changed 4 years ago by Saksham Agrawal

comment:8 Changed 4 years ago by Saksham Agrawal

0003 and 0004 are the final patch files.

I have changed all the .rst and readme files where I could find the occurrences of "mediagoblin_local.ini".

I am extremely sorry for so many errors.

comment:9 Changed 3 years ago by Boris Bobrov

0004 suggest to use mediagoblin_local.ini. Why?

Also, there are too many whitespace changes. For example, in many files you add whitespace after dots. Please remove these whitespace changes.

comment:10 Changed 3 years ago by Boris Bobrov

Status: reviewaccepted

comment:11 Changed 2 years ago by ayleph

Milestone: 0.10.0

comment:12 Changed 2 years ago by ayleph

Looking at this again, it appears that patches 2 and 3 had some good changes, but then patch 4 pretty much undid everything. Patches 2 and 3 don't apply now, but they give me a place to look for changes that need to be made.

comment:13 Changed 22 months ago by dpg

This bit me previously. Updating the documentation now.

Changed 22 months ago by dpg

Attachment: remove-local.patch added

Little confused. It seems the online documentation just needs synced with the master branch?

comment:14 Changed 13 months ago by ShawnRisk

Status: acceptedreview
Note: See TracTickets for help on using tickets.