hechoendrupal / drupal-console-book Goto Github PK

As commands/arguments/options are added and changed, maintaining the "how to use" section of the documentation will inevitably get tricky and the documentation will get outdated and possibly full of inaccuracies. A simple script (in the Drupal Console project) could output all the "how to use" files as Markdown, ensuring all commands are documented and include all current arguments and options. This issue is to discuss pro/cons of this and a most suitable approach.

Other thoughts: Maybe a new command: drupal generate:documentation ... It could output .md files to a selected directory.

A recent change renamed the cli tool from console to drupal. I noticed some places in the documentation that still mention the old console command and others that have the new drupal command.

I'm happy to provide a PR to fix, but I wasn't sure what parts of the documentation get automatically generated and which parts need updating.

Example old name https://hechoendrupal.gitbooks.io/drupal-console/content/en/getting/composer.html
Example new name https://hechoendrupal.gitbooks.io/drupal-console/content/en/commands/help.html

I Liked how the rules module documentation, separated Contribute and Extending sections, makes sense to me, any thoughts @LowellMontgomery ?

In this link you can see what I mentioning
http://thefubhy.gitbooks.io/rules/content/contributing/index.html

I also include a screenshot

It should not be hard to iterate the files and build such a links page programmatically... a simple script could automate the process. Maybe you have a nifty, Symphony-powered approach or trick you have already used? If so, we should document that. If not, we should find something (or write something) and use it.

Hi,
after a global installation of the drupal console with composer on windows 7 ,
I can't remove it when using :

composer global remove drupal/console:@stable

nothing has been removed, this is the message

$ composer global remove drupal/console:@stable
Changed current directory to C:/Users/David/AppData/Roaming/Composer
drupal/console:@stable is not required in your composer.json and has not been removed
Package "drupal/console:@stable" listed for update is not installed. Ignoring.
Loading composer repositories with package information
Updating dependencies (including require-dev)
Nothing to install or update
Generating autoload files

as user, i would like to know (being listed) all the possible caches to rebuild.
«all» argument rebuilds all, it's clear. but how rebuild content or menus cache specifically?

i can't find that in the "cache:rebuild" page ...

I get this output:

$ curl http://drupalconsole.com/installer -L -o drupal.phar % Total % Received % Xferd Average Speed Time Time Time Current Dload Upload Total Spent Left Speed 0 0 0 0 0 0 0 0 --:--:-- --:--:-- --:--:-- 0 0 0 0 0 0 0 0 0 --:--:-- --:--:-- --:--:-- 0 curl: (35) error:14077410:SSL routines:SSL23_GET_SERVER_HELLO:sslv3 alert handshake failure

Review and update Russian translation

check: hechoendrupal/drupal-console#2065 & hechoendrupal/drupal-console#2124
We'll have to update the file: drupal-console-book/en/commands/module-download.md with the new option module-path (the others options should wait atm)

On page 33 both sample code contains -n parameter, but the note says:

In this example code, we accept all interactive questions, i.e. answering “yes” when passing the -y argument.

I think note should match the sample code.

Docs currently have documentation for the site:mode command https://docs.drupalconsole.com/en/commands/site-mode.html. In the current releases this is not an available command, although it appears this command will return later. Might be a good idea to mark this command as currently unavailable in the documentation so as to not create any confusion for users.

The idea of this issue is to extend this page or add new pages to clarify the instructions to create a contributed command.

Related issue:
hechoendrupal/drupal-console#458

Problem / Motivation

We should provide some basic information about what is DrupalStyle in Drupal Console.

Checkout the Symfony Style page as example - http://symfony.com/blog/new-in-symfony-2-8-console-style-guide

I think we should have a note that you can't generate code if the module is enable. In this documentation page. http://hechoendrupal.gitbooks.io/drupal-console/content/using_drupal_console/available-commands.html

I try to run drupal generate:form:config and did not let me run into uninstall the module.

Docs currently have documentation for the site:new command https://docs.drupalconsole.com/en/commands/site-new.html. In the current release this is not an available command. Presumably this was caused by the changes to the launcher. Might be a good idea to mark this command as currently unavailable in the documentation so as to not create any confusion for users.

The steps on https://docs.drupalconsole.com/en/getting/composer.html are not clear. Are we supposed to both do a require - presumably inside an existing composer project? - AND create a project? If so, how do the two steps relate? If we are meant to do one or the other, do any of the other steps on the page apply to both, or only one, or ?

What is the thinking behind these commands, what is it that they are intended to accomplish?

Currently this page is out of date and gives unclear direction as to how and why you need to install both the Launcher and per site.

Some commands don't work unless certain modules are enabled and this should be made clear in the documentation.

For example, drupal migrate commands won't work unless the Migrate module is enabled.

Hi I've solved this issue:

[+] Downloading Drupal 8.0.0
[+] Unable to open /tmp/drupal.H9qBxktar.gz using mode r+: fopen(/tmp/drupal.H9qBxktar.gz): failed to open stream: No such file or directory

watching a conversation under: https://gitter.im/hechoendrupal/DrupalConsole?at=565e0bce65c2a5b027d72ba7

I think it's a good idea to reccomend php5-curl prerequisite under documentation

Regards
menteora

Content missing for files

• FAQ > Permissions
• FAQ > Interactive Mode

for all languages
Depends on #220

Add a page to the book explaining how to setup use and test this tools.

Related to: hechoendrupal/drupal-console#200

Problem / Motivation

Since this issue is been solve - https://github.com/Homebrew/homebrew-php/issues/2665#event-524049582 . Users can get DrupalConsole if they have homebrew + homebrew-php.

Solution

We should document somewhere in the DC book that it can be install with homebrew-php.

The instructions here don't mention that launcher is not all you need to get console working for any given site: https://docs.drupalconsole.com/en/getting/launcher.html

Or at least, they don't explain what the launcher actually is. There's no mention that it's not the whole of Drupal Console.

In SUMMARY.md, the links to files

• FAQ > Permissions
• FAQ > Interactive Mode

go to 404 page for all languages

Console has the ability to do more than generate code.

After some time your forked repository and the original one(called upstream) will eventually get out of sync leaving you with an old, unsupported version.

This page should include instruction how to keep for up to date

https://github.com/hechoendrupal/drupal-console-book/blob/master/en/commands/module-install.md

The --composer option says "Uninstalls the module using Composer" but if the command is install shouldn't that read "Installs the module using Composer"?

I like how d.o. provides a template to create an issue.

Since Github provides similar functionality by adding a new file, named CONTRIBUTING or CONTRIBUTING.md to the root directory of your repository, more info:
https://help.github.com/articles/setting-guidelines-for-repository-contributors/

I added a CONTRIBUTING.md file to the repo code project

Issue where this was added:
hechoendrupal/drupal-console#680

We already had a page related to Create an issue on his repo, what will make more sense:
a) Update and keep the page duplicating the CONTRIBUTING.md file.
b) Update page content and include a link to the CONTRIBUTING.md file.

Thoughts @LowellMontgomery

This will make it easier for us to link to a page that can link to the sub pages that give advice for fixing problems.