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

Make details on demand easier to maintain #2882

Closed
4 of 7 tasks
Tracked by #3562
ikesau opened this issue Nov 1, 2023 · 4 comments
Closed
4 of 7 tasks
Tracked by #3562

Make details on demand easier to maintain #2882

ikesau opened this issue Nov 1, 2023 · 4 comments

Comments

@ikesau
Copy link
Member

ikesau commented Nov 1, 2023

Background

We've been using Dods a lot now and like them. The current solution is based on a single, special DoD document that contains all terms (~360 or so as of June 2024).

Problems

Having all of these in one GDoc and not having any admin UI support for them comes with a few downsides:

  • There is no support for structuring DoDs into groups by topic
  • There is no visibility into how many views different DoDs get, which makes it hard to prioritize which ones to tweak
  • Conceptually there is a problem that only a single person should be working on any one document at any time and hitting publish. For most GDoc articles this is not a problem but for the big DoD document with lots of small pieces of content we could actually run into a case where two people edit the document simultaneously and one person hits publish and thus publishes an unfinished DoD the other person was editing.
  • There is no clear concept of ownership - probably topic groupings will help with that but we could also go further and have explicit authors for each Dod.

Proposed solutions

⭐ Quick and easy

  • Ensure you can have headings in the DoD document and that they are stripped in dod.json
  • Improve DoD performance #3757
  • Add analytics for DoDs
    • Add a new show event for DoDs
    • Visualise show events
  • Improve clicks explorer to make time comparisons easier (see: Notion)
  • (optional) Add an optional author field for coordination

More elaborate solution

  • Change the internal one document approach to a new DoD document type of which you could have multiple, e.g. per topic
  • Create a new admin space where you search for Dod terms and open the correct doc
  • In this view also show uses of DoD terms and aggregated pageview counts
@danyx23
Copy link
Contributor

danyx23 commented Jan 16, 2024

We chatted about this and it seems that the main problem that we want to alleviate is that publishing the one DoD doc is problematic (others might be in the middle of editing in another place).

One solution to that problem would be to change the system so that instead of one "hardcoded" id that is the DoD document we would create a new type (that should be visible as such in the GDocs admin) so that we can have a handful of DoD docs (e.g. one per topic area).

@ikesau
Copy link
Member Author

ikesau commented Jan 16, 2024

@rakyi
Copy link
Contributor

rakyi commented Jun 14, 2024

We added analytics to track usage of DoDs instead of using Datasette queries.

@larsyencken larsyencken changed the title Detail on demand admin enhancements Make details on demand easier to maintain Jul 2, 2024
@larsyencken
Copy link
Contributor

Closing this one as done, and tracking the two follow-up issues instead.

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

No branches or pull requests

4 participants