Skip to content
This repository has been archived by the owner on Mar 7, 2023. It is now read-only.

Add blank document and crosslinks for work-items #15

Merged
merged 2 commits into from
Oct 9, 2020
Merged

Conversation

alerque
Copy link
Collaborator

@alerque alerque commented Oct 7, 2020

Our charter mentions and links to this document, but it as of yet it hasn't existed. For the ease of people wanting to add items to it (see e.g. this potential work item) here is the blank template and links necessary to get to it.

@lianghai
Copy link
Contributor

lianghai commented Oct 8, 2020

If there’s a way to automatically dump a list of links to all the work-items directory’s files into the index.md file, we should do that. Otherwise, let’s just leave a link (to the directory on github.com) in the index.md (so visitors viewing the github.io page is redirected), so people don’t feel the need to update this index.md every time a new work item is added.

@lianghai
Copy link
Contributor

lianghai commented Oct 8, 2020

Oh wait, after re-reading @simoncozens’s #8 (comment), I’ve realized that I need to confirm: Is the work-items directory meant to host all the work item files at all, or just meant to be a single register page that provides links to files elsewhere?

@alerque
Copy link
Collaborator Author

alerque commented Oct 8, 2020

I actually think it might be of some utility to keep a hand-written index up to date. It could have some summary information like a real title, a when and who, and other links without needing to dive into each one. I don't expect much churn because these aren't issues that will be opening and closing all the time, they are longer running projects, possibly even spawning other groups.

However as there is no harm in starting out with a link to the repository directory I've gone ahead and added that.

@alerque
Copy link
Collaborator Author

alerque commented Oct 8, 2020

I was initially envisioning it would be a register page, but it might be useful to have a file list too. In most cases they wouldn't be the actual work, just the proposal to start the work and the plan for how it would be done. Those proposals might fit in a section-per-proposal, but a file-per-proposal could work too. And the latter would make it easier to see who was involved in which proposals from Git history.

@alerque
Copy link
Collaborator Author

alerque commented Oct 8, 2020

Per this comment I'll look into what we can convince GitHub's stripped down Jekyll to do for us as far as an automatic index from a directory and perhaps meta data. In the mean time I think this can be merged as-is to provide a directory for such charter PR's to start working in.

@lianghai lianghai merged commit 82ea4ce into main Oct 9, 2020
@lianghai lianghai deleted the create-work-items branch October 9, 2020 07:41
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants