This is a pretty big project, but I want to get it out there. I want a website that parallels the content here on GitHub so it's easier to browse the content for folks that aren't yet (or won't ever) contributing to the project.
I imagine a few things:
The content on the website matches what's in the master branch at all times. I don't know the best way to achieve it, but I imagine the backend could either ping the GitHub API and literally mirror what's in GitHub, or we could implement some sort of build process that parses and converts all the markdown and folder structure every time there's a commit to master. I don't have much experience with automating build processes, but I know it's possible.
Comments could be tied into the 'Issues' API here on GitHub as well. I imagine something where the comments live here as an Issue, and we format it to look pretty on the website. You can comment in either the comment section or the associated issue, and the changes will be reflected both places. This allows folks to participate where they feel most comfortable, but also keeps all comments centrally located with a focus on making progress on the project. You could use the 8 digit timestamp ID in each filename as a unique identifier for the issue title.
A tag could be created (something like comment-thread or similar) to identify those ongoing comment threads.
The very first comment/description section in the issue could be auto populated as a meta data description. Include a link to the website, the title of the article, maybe some summary text. Something like that. All following comments (and maybe even history like tag changes and stuff) are what gets displayed on the website, but not that first meta description. This allows contributors to fully participate on either platform.
Only create an issue when someone actually leaves a comment on the page. No need to clutter the issues with a bunch of non-issues.
I want there to be some way to see older versions of the same article if it's been updated. Since only the master branch is what's displayed on the website, you can do some diff parsing and display older versions via a dropdown menu that lists only the relevant commits.
wScottSh
commented
4 years ago
This is a pretty big project, but I want to get it out there. I want a website that parallels the content here on GitHub so it's easier to browse the content for folks that aren't yet (or won't ever) contributing to the project.
I imagine a few things:
masterbranch at all times. I don't know the best way to achieve it, but I imagine the backend could either ping the GitHub API and literally mirror what's in GitHub, or we could implement some sort of build process that parses and converts all the markdown and folder structure every time there's a commit tomaster. I don't have much experience with automating build processes, but I know it's possible.comment-threador similar) to identify those ongoing comment threads.masterbranch is what's displayed on the website, you can do some diff parsing and display older versions via a dropdown menu that lists only the relevant commits.