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

Remove scheduled-docs specific format from schedule-badge example #6

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

paciorek
Copy link
Collaborator

Per issue #2, it makes more sense to have the schedule template example not depend on scheduled-docs.

@andrewpbray
Copy link
Contributor

For the documentation site, though, it might be helpful to have both, no?

@paciorek
Copy link
Collaborator Author

Actually, I'm not sure. As I was seeing it the only difference needed for including scheduled-docs functionality is to add this to the top of the schedule-example.yml file (if one is already using docs in the schedule-example.yml file, which I am doing for the schedule-badge case):

scheduled-docs:
  draft-after: "2099-08-24"
  timezone: "-07:00"
  debug: true
  schedule:

So one thought is just having that documented clearly in the scheduled-docs documentation, rather than having multiple examples per schedule template.

@andrewpbray
Copy link
Contributor

That's true. I guess I"m thinking of wall-calendar, which takes advantage of the trickle-down functionality of scheduled-docs, so I wouldn't want users to have to think they have to repeatedly type in all those fields.

Okay, how about this: I'm imaging using tabsets in the doc site to have, for each template, the output, and the contents. Both will read in programmatically from the ejs and example yml (post scheduled-docs version). We add additional notes under the contents tab to clarify anything we think the user could find helpful, like this trickle down thing.

How's that sound?

@andrewpbray
Copy link
Contributor

(that's to say, we'll stick with output-only yml in the extension and relegate the rest to the docs site).

@paciorek
Copy link
Collaborator Author

At a high level that sounds good, but at the moment, I'm not entirely clear what should go in to course-website and what documentation would go directly into course-website-ejs.

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

Successfully merging this pull request may close these issues.

2 participants