Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

How tos : confirm location of how to type documentation. #193

Open
finnlewis opened this issue Jun 7, 2023 · 4 comments
Open

How tos : confirm location of how to type documentation. #193

finnlewis opened this issue Jun 7, 2023 · 4 comments

Comments

@finnlewis
Copy link
Member

Discussing how-to documentation in the product backlog group with @willguv and @stephen-cox.

The case in point is adding https://www.drupal.org/project/content_lock

Once we add it, it will probabyl not be enabled by default on a stock install.

So we would like to be able to direct people at a clear "how to enable and configure content lock".

I guess this best lives on the https://docs.localgovdrupal.org/ site, but where?

Some of this how-to documentation could be for multiple audiences, but probably mainly developers.

  1. A new top-level section for "How tos" ?
  2. A new section under developers for "How tos" ?
  3. a seperate section for "How-tos" which is not necessarily linked to from the top level primary links?

@msayoung do you have thoughts on this?

@willguv
Copy link
Member

willguv commented Jun 7, 2023

Thanks for posting Finn

Think these will mostly be about extending core functionality, so is the section "Extending LGD"?

Also would enable us to point to bigger things councils have built, for example Croydon's Forms work

@msayoung
Copy link
Member

msayoung commented Jun 7, 2023

I think a section under Developers for How-tos

There is currently a similar section under Content designers : https://docs.localgovdrupal.org/content/how-to/

And another in Microsites https://docs.localgovdrupal.org/microsites/how-to/

@stephen-cox
Copy link
Member

From our discussions I'm not sure this is developer documentation. Some of it might be how to manually deploy the latest update (which could be field config changes, for example) and some of it is how to install and configure extra modules (autosave functionality as another example we were discussing).

The audience for this (in my mind) are the people who use the site to publish information and want to know what features they can add to their site. Perhaps this means splitting this, a high-level things you can do with your site for the users / content editors and technical how-tos for developers.

@finnlewis
Copy link
Member Author

We now have: https://docs.localgovdrupal.org/devs/how-to/

We also want to add a list of optional extensions:

  1. that we maintain (localgov_new_thing)
  2. modules that we don't maintain that might be useful:
  3. other things?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants