-
-
Notifications
You must be signed in to change notification settings - Fork 16.4k
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
Staticman GitHub App support #541
Comments
Static man is already supported for comments. What feature exactly are you requesting? I try not to bloat this theme with too much info specific to one small feature in it (that is - I prefer not to have huge docs sections dedicated to staticman) |
Yes, using the staticman github app v3 instead of the |
I'll defer to @VincentTam - he brought in staticman and would understand the question better |
@wini3d Since I ported Staticman Integration from Minimal Mistakes in #440, this theme has been using Staticman v3 API scheme, which has been merged in eduardoboucas/staticman#219. After several months, the action URL was moved into JS in #521 to avoid spam bots. beautiful-jekyll/js/staticman.js Line 14 in c74b503
Since I've (and I'll) never used GitHub Apps (for reasons listed in my earlier comment eduardoboucas/staticman#299 (comment).), I'll leave interested users to write the instructions for using GitHub Apps. Be aware that
Whether the app version is used or not, the v3 API scheme and the input and output data format has not been altered by eduardoboucas/staticman#255. As a static blog theme, it doesn't care the actual functioning of the API server—that's a Staticman (as a node.js app) issue. Instead, we handle data files received from the API server, and render them into HTML elements to be displayed. Staticman's support for GitHub Apps eduardoboucas/staticman#255 has neither changed the input/output data structure nor the POST URL structure introduced in eduardoboucas/staticman#219, based on which #440 was made. Therefore, I see no need to modify our Jekyll-HTML template in view of eduardoboucas/staticman#255. My bot @staticmanlab, forked from the
That's off-topic here, for the reason I've explained above. You may go to the official Staticman repo to start an issue there—you've done that in eduardoboucas/staticman#310, or leave a comment under my blog article Staticman API Hosting 2018. 🚫 Staticman v2 no longer works on official production instance, as reported in eduardoboucas/staticman#306. |
Thank you. So are you suggesting to fork the merge from eduardoboucas/staticman#219 to have the same exact copy that your staticmanlab herokuapp is using? |
In my linked guide for setting up Staticman API, there's a comparison between my The great thing about a Git branch is that it gives a short reference name to a feature/modification, so that you can easily make comparisons. You don't need to follow every step in my post, like
Braching against the |
Thanks @VincentTam . I just tried your deploy branch, the invite went successfully but getting 500 Internal Server Error when posting comments. I just changed the form action url from your staticman3 to my heroku url. |
I'm going to close this issue because it's not relevant to beautifuljekyll - feel free to continue this discussion privately or in another repository where it makes sense :) |
@wini3d I had lost my concentration for a few seconds browsing various issues. I should have answered your question in a GitHub issue under Statimcan's repo since that's a question about Staticman's API rather than this theme's Staticman integration. To understand what type of questions about Staticman is on-topic here, you may think about an ATM. Staticman's API is like the ATM's interface. A static blog theme deals with stuff "in front of" the interface (e.g. conversion of HTML form data into an appropriate POST request), and it doesn't care about what's "behind the ATM's interface" (e.g. how the POST request is converted to a Git commit object). |
Thanks, I understand that and I have updated some findings here. We can move this discussion now to that issue. |
@daattali Documentation request/questions for setting up a site using this theme with an existing Staticman v3 API is on-topic here, since there's some theme-specific parameters in each theme with Staticman support. Here's the right place to place to ask questions/discussions about these parameters. Lines 130 to 138 in 96c2508
I interpret the question on the top in this way: "Does the above parameters support the GitHub Apps version of Staticman? Does this repo's README cover this?". That's surely on-topic here. Since this repo's README doesn't cover the GitHub Apps version of Staticman, a normal user of this theme might be in doubt of this theme's capability to support that. As a result, it would be good to see some volunteer updating the README regarding the the GitHub Apps version of Staticman. I've never used that, so I have to leave that to others.
Since the request for README update has not yet been addressed, it would be better to re-open this until the README says clearly that the GitHub Apps version of Staticman is supported by this theme. The only off-topic part here is the question about setting up own API instance. I've pointed that out in my previous comment.
I wrote the above paragraph in my previous comment in order to clarify the following claim, which is not entirely valid. I wasn't aware that would trigger another question.
|
@VincentTam do you know if there are any updates on staticman? I just checked https://staticman.net/ and there is no mention at all of a v3 API, only v2. If v3 isn't official or recommended yet, I'd like to close this issue |
As far as I understand, v3 that was discussed here is not an official recommendation. Due to lack of response here, I'm closing this issue. If someone wants to raise this issue again with more information, please do |
@daattali I'm sorry for my lack of response. I suffered from game addiction during the lockdown. Learning C# now, I'm a little bit more active on Git* than before. As far as I know (about the node.js app one year ago), the idea of a public instance isn't scalable. When everybody uses it, the it can get "congested". It's true that the official website has no mention about the newly introduced API variables in v3. The file Regarding the question on "recommendation", here's one from the project's maintainer.
I believe that he, as the maintainer, would recommend a version of the app with recent bug fixes. Documenting recent changes takes time. If the maintainer/owner doesn't have the time and effort to do it, and a 3rd-party person doesn't have the energy to test all the features, it's hard for him/her to come up with an encyclopedia-like "documentation". |
I understand those concerns, but I still would be a little hesitant to use a new version that isn't at all mentioned on the official site whatsoever. |
@wini3d @daattali Sorry I'm eating my words again. Due to the quoted comment from the app's maintainer, I'm going to submit a PR for a README update about the GitHub App setup on a custom Heroku app instance. I've found the motivation to try out the GitHub App, thanks to a clearly-written blog article https://hajekj.net/2020/04/15/staticman-setup-in-app-service/. Here's some screenshots showing my successful setup. Staticman's README : https://github.com/eduardoboucas/staticman Click the deploy button inside , and configure the necessary variables in the popped up Heroku page in order to start Staticman with no installation.
Successful example: VincentTam/TestStaticmanLab#95 Remarks: If you're using Heroku's online dashboard, simple copy-and-paste the RSA private keys for the config variables After removing all |
More on a feature request. I was wondering if you are planning to have this supported or if it is already, is there a doc?
https://github.com/apps/staticman-net
Also, any guide on how to setup your own heroku staticmanlab instance?
The text was updated successfully, but these errors were encountered: