Someone has created https://www.drupal.org/docs/7/modules/version-control-api-git-backend with links to docs per version on a http://misc.marvil07.net/ All the links are 403. If no of the links are likely to work again, I will remove the page.

PS! Yes, I know there is a readme in Git.

Comments

hansfn created an issue. See original summary.

marvil07’s picture

marvil07 commented
Status: Active » Fixed

Thanks for reporting that!

I have changed the links, basically I needed to be a bit more specific and add the final html file on the links.

hansfn’s picture

hansfn commented
Status: Fixed » Needs work

Thx for the quick fix. Looking at the links I see it's just a parsed version of the readme that is in Git ...

You probably should add some more info in the actual documentation guide/page. Or just move those 3 links to the project page and remove the documentation page. (There are requirements for such doc guides/pages.)

marvil07’s picture

marvil07 commented
Status: Needs work » Postponed (maintainer needs more info)

@hansfn, can you point me to the documentation requirements?
I could only find https://www.drupal.org/docs/develop/documenting-your-project/module-docu... and I see there some suggestions, but not requirements.

hansfn’s picture

hansfn commented

The guidelines for a documentation guide - like your https://www.drupal.org/docs/7/modules/version-control-api-git-backend - isn't clear yet. There is a major documentation initiative going on. Anyway, my point is that if you create a doc guide just to put 3 links there, it's better to keep it on the actually project page.

drumm’s picture

drumm
he/him
Location NY, US
commented

I’m not aware of any meta-documentation about this specifically. The guides, and book pages before them, were generally documentation that went beyond the readme. For example, https://www.drupal.org/docs/7/modules/api-module has detailed setup instructions, and troubleshooting. This of course varies widely for different modules—straightforward modules will have simple documentation.

For the current links, I’d agree they’d be best on the project page directly. That would save users a click though the documentation guide. If there are plans to expand documentation for the project, the guide is a good place to start.

marvil07’s picture

marvil07 commented
Status: Postponed (maintainer needs more info) » Active

Let us use only in-code documentation for now.

I could not find a way to remove the documentation guide, so I'm not sure what to do.
I have removed the reference on the main project, so it is not linked anymore at least.

drumm’s picture

drumm
he/him
Location NY, US
commented
Status: Active » Fixed

I deleted that documentation guide.

Status: Fixed » Closed (fixed)

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