No help page is provided yet. Also, the README is out-of-sync with the project page.

Also removed an unused variable.

CommentFileSizeAuthor
#27 gitinfo-new_README-3074095-27.patch16.72 KBlolandese
#22 readme_update-3074095-22.patch4.13 KBlolandese
#19 new_readme-3074095-19.patch16.97 KBlolandese
#15 new_README-3074095-15.patch19.95 KBlolandese
#8 readme_and_help-3074095-8.patch14.55 KBlolandese
#2 readme_and_help-3074095-2.patch13.18 KBlolandese

Comments

lolandese created an issue. See original summary.

lolandese’s picture

lolandese commented
Status: Active » Needs review
StatusFileSize
new readme_and_help-3074095-2.patch13.18 KB

As keeping in sync the Drupal.org project page, README.md and help section can be a burden, we provided a patch where:

This methodology can be used for any other Drupal project as well.

lolandese’s picture

lolandese commented
Status: Needs review » Reviewed & tested by the community

Viewed both the help section at admin/help/gitinfo and the formatted version of the README.md with the PhpStorm integrated markdown viewer.

  • lolandese committed 241ccad on 8.x-1.x 
    Issue #3074095 by lolandese: Keep in sync the Drupal.org project page,...
lolandese’s picture

lolandese commented
Status: Reviewed & tested by the community » Fixed

Status: Fixed » Closed (fixed)

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

lolandese’s picture

lolandese commented
Status: Closed (fixed) » Active

Reopening as the project page, README and help should be updated to prepare for a new stable release.

lolandese’s picture

lolandese commented
Status: Active » Needs review
StatusFileSize
new readme_and_help-3074095-8.patch14.55 KB
lolandese’s picture

lolandese commented
Status: Needs review » Reviewed & tested by the community

Viewed both the help section at admin/help/gitinfo and the formatted version of the README.md with the PhpStorm integrated markdown viewer.

  • lolandese committed 26456e8 on 8.x-1.x 
    Issue #3074095 by lolandese: Keep in sync the Drupal.org project page,...
lolandese’s picture

lolandese commented
Status: Reviewed & tested by the community » Fixed
lolandese’s picture

lolandese commented

Just to note:

  • Linebreaks forced with a double space have been replaced with a backslash(\) to avoid trailing whitespace errors.
  • Inside inline code using the tick (´) sometimes HTML spans get added when doing the HTML to Markdown conversion. Corrected "by hand".

Status: Fixed » Closed (fixed)

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

lolandese’s picture

lolandese commented
Status: Closed (fixed) » Needs work

Sync the README with the updated project page.

lolandese’s picture

lolandese commented
Status: Needs work » Needs review
StatusFileSize
new new_README-3074095-15.patch19.95 KB

  • lolandese committed 3335c40 on 8.x-1.x 
    Issue #3074095 by lolandese: Keep in sync the Drupal.org project page,...
lolandese’s picture

lolandese commented
Status: Needs review » Fixed
lolandese’s picture

lolandese commented
Status: Fixed » Needs work

Needs update (sync project page).

lolandese’s picture

lolandese commented
Status: Needs work » Needs review
StatusFileSize
new new_readme-3074095-19.patch16.97 KB

  • lolandese committed cbfb9df on 8.x-1.x 
    Issue #3074095 by lolandese: A new README.md
lolandese’s picture

lolandese commented
Status: Needs review » Fixed
lolandese’s picture

lolandese commented
Status: Fixed » Needs review
StatusFileSize
new readme_update-3074095-22.patch4.13 KB

Sync project page and README prior to a new stable release.

  • lolandese committed 023bdec on 8.x-1.x 
    Issue #3074095 by lolandese: Keep in sync the Drupal.org project page,...
  • lolandese committed 5f668d5 on 8.x-1.x
    Issue #3074095 by lolandese: Keep in sync the Drupal.org project page,...
lolandese’s picture

lolandese commented
Status: Needs review » Fixed

Status: Fixed » Closed (fixed)

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

lolandese’s picture

lolandese commented
Status: Closed (fixed) » Needs work

We have a new upcoming stable release and should update the README.

lolandese’s picture

lolandese commented
Status: Needs work » Needs review
StatusFileSize
new gitinfo-new_README-3074095-27.patch16.72 KB

  • lolandese committed d2d1955 on 8.x-1.x 
    Issue #3074095 by lolandese: Keep in sync the Drupal.org project page,...
lolandese’s picture

lolandese commented
Issue summary: View changes
Status: Needs review » Fixed

Included a small bugfix to correct a previous moved code block.

Status: Fixed » Closed (fixed)

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