juanra/docs/examples-debug

[juanrmn]

Move some interesting old-examples notebooks to examples/_debug folder.

[makella]

@juanrmn thanks for doing this!

Couple of comments/questions:

• First, and probably most importantly, What purpose do we see the _debug folder serving? If it is a place to find an example to quickly test, I would consider having some simple maps/use cases available by topic
  • related, having the credentials set would be really helpful but I'm not sure if that is realistic/doable with these being public. what do you think?
• The police analysis notebook we have in our new examples in the "Use Case" section so I don't think we need a duplicate - or would this be a good test case for debugging?
• Are the DO examples meant to be moved to the examples section?
• Finally, do you think that any of the examples that are in _debug should be in one of our current examples sections?

thanks!

[juanrmn]

Hi @makella, thanks to you for review it :)

About your questions, in the same order:

• The purpose of the _debug folder is just to have "a bag or hodgepodge" with the previous most interesting examples that would be a pity to be deleted (please @elenatorro, correct me if I'm wrong).
  • For running these examples as local quick tests, I think it's possible by having the credentials stored with credentials.save() method, and then the notebooks can use credentials = Credentials.from_file() when necessary. This way you can open them, run all cells, and look for exceptions. Is that what you meant?
• About the police analysis notebook, it wasn't my intention to duplicate.. so I think I'm going to remove it from the _debug folder...
• I think that @elenatorro is working on doing better DO examples, so these will be probably outdated soon. I've just included them here in the meantime.
• In my opinion, the current examples are better for what they are. More concise, so I wouldn't include any of these _debug ones :)

Thanks!

[elenatorro]

Hi!

• As @juanrmn says, the _debug folder is to keep the examples we consider useful for us but that we don't want to expose in the documentation in the developer center. We need to keep this directory as tidy as possible (otherwise, it'd be hard to maintain).

• As you both said, we can remove the analysis_police_department_incident_reports one from the _debug dir 👍

• About DO examples: after testing the examples and talking with different members of the team, my conclusion is that it's better not to include any DO example at this point. There are many reasons, but basically it's not ready to be used. We've added a warning in the reference section of the DO that links to a contact form, cause all we have ready now is for enterprise users.

  • Note: I'd mention this in the next weekly so we can make a plan for DO integration + documentation for the RC1

[elenatorro]

Apart from the duplicated example we need to remove, LGTM 🚀