While this module has a great potential, it lacks in documendation. I believe that we can improve in this section.

I'm making a first attempt to provide a readme file, as complete as I can. Please check it and tell me if there is something more to be added.
I believe there should be some section about patching views and/or views compatibility. Am I right?

CommentFileSizeAuthor
#6 improve_documendation-2383839-5.patch2.61 KBpwaterz
#4 improve_documendation-2383839-4.patch2.98 KBbserem
#1 2383839_first-attempt-towards-a-readme-file-1.patch3.99 KBbserem
Support from Acquia helps fund testing for Drupal Acquia logo

Comments

bserem’s picture

bserem CreditAttribution: bserem commented
Status: Active » Needs review
FileSize
2383839_first-attempt-towards-a-readme-file-1.patch3.99 KB
antongp’s picture

antongp CreditAttribution: antongp commented
Assigned: bserem » pwaterz
Status: Needs review » Needs work

Hi.

Thank you for your issue! Totally agree with you, module needs for good README file. I'll also create issue to update project's page. Also I'm working now on minor updates in UI, including help texts.

I reviewed your patch. Looks like it's more about 7.x-1.x rather than 7.x-2.x branch. 7.x-2.x does not provide own field storage, it alters default field storage instead so there is no need to execute code for switching field storage. Views should work properly as well, without any patches. And i would not drop revision tables in any case...

About credits at the end: i think it's for pwaterz or alexpott to decide add it or not, and in which form.

Thanks again.

bserem’s picture

bserem CreditAttribution: bserem commented

I used the 7.x-2.x version, but could't really understand whether I needed to change the storage or not.

As for the credits, it is just a habit :)

I'll provide an updated patch in the weekend. I also plan to test the module before christmass, hopefully with some benchmarking.

bserem’s picture

bserem CreditAttribution: bserem commented
FileSize
improve_documendation-2383839-4.patch2.98 KB

Attaching a new file, should cover the changes by antongp.

bserem’s picture

bserem CreditAttribution: bserem commented
Status: Needs work » Needs review
pwaterz’s picture

pwaterz CreditAttribution: pwaterz commented
FileSize
improve_documendation-2383839-5.patch2.61 KB

Thanks for the patch, I have updated it slightly. Let me know what you think.

bserem’s picture

bserem CreditAttribution: bserem commented

I would also add the line about version 2 being incompatible with version 1. Other than that it seems fine to me.

btw: what is a sass based service?

pwaterz’s picture

pwaterz CreditAttribution: pwaterz commented

woops that meant to be SaaS based service. At my company we deal with hundreds of millions scholarly journal articles. The articles are stored in a different system, drupal accesses that content through a SaaS (Software as a service) service.

bserem’s picture

bserem CreditAttribution: bserem commented
Status: Needs review » Needs work

Oh... SaaS makes sense :)

There is only one thing left to document:
If revisions are disabled can a user enable them at some point?

I'm not talking about revision data but about the functionality of having revisions enabled in the future.

antongp’s picture

antongp CreditAttribution: antongp commented

I believe yes, it's possible to enable revisions functionality at some point. First of all, user needs to un-tick corresponding checkbox on the module's settings page. The 2nd thing is to populate revisions' tables by data. Easiest way is to resave nodes/entities, using content administration page or VBO module for batch processing or some other way. But it may take a time on a big numbers of entities. Second option is to perform DB queries directly.

  • antongp committed 40a5e0e on 7.x-2.x 
    Issue #2383839 by bserem, pwaterz, antongp: Improve Documentation
antongp’s picture

antongp CreditAttribution: antongp as a volunteer commented

Hey guys.

Returned to this issue...
http://cgit.drupalcode.org/field_sql_norevisions/tree/README.txt?h=7.x-2.x
- formatting conforms to https://www.drupal.org/node/2181737 template, also I've made updates in the text and moved some things to FAQ section. Have I missed something?

Thanks.

1mundus’s picture

1mundus CreditAttribution: 1mundus commented
Title: Improve Documendation » Improve Documentation

@antongp

This readme looks good. The only thing I would add is Enable statistics option in Phpmyadmin. So, after the answer to Q: How can I evaluate storage space savings after installing the module? you could add something like this:

If you use Phpmyadmin, you can go to "Databases" page and under the list of databases click "Enable statistics". If you enable it, Phpmyadmin will display some basic database stats - Tables, Rows, Data, Indexes, Total and Overhead.

pwaterz’s picture

pwaterz CreditAttribution: pwaterz commented

Thanks for the info. I don't think that should go in the Readme. It's pretty easy to do a google search on how to get table and database size.

1mundus’s picture

1mundus CreditAttribution: 1mundus commented

Sure, but info on checking the size (with sql queries) is already in readme, so this might be a useful addition, considering that it's easier to do that than to run sql queries.

bserem’s picture

bserem CreditAttribution: bserem as a volunteer and at SRM for SoLebIch commented

Well, some of us don't use phpmyadmin, which as a GUI is easy to find this type of information. The SQL queries are in the readme mainly because they are kinda weird queries and not so easy to think of.

Either way, a readme is a readme, it is good to have info in there as long as it isn't bloat.

heddn’s picture

heddn
Primary language English
Location Nicaragua
CreditAttribution: heddn at MTech, LLC, Forum One commented
Status: Needs work » Fixed

We had a commit on this issue already. If we want to continue the conversation, let's do that in a new issue?

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.