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.

Sign up for GitHub

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

Jump to bottom

Publish target API architecture on blog #2344

Open
mikesmit opened this issue Feb 6, 2025 · 3 comments · May be fixed by #2345
Open

Publish target API architecture on blog #2344

mikesmit opened this issue Feb 6, 2025 · 3 comments · May be fixed by #2345
Assignees
@mikesmit

Comments

@mikesmit
Copy link
Collaborator

mikesmit commented Feb 6, 2025

We now have a target API architecture. We should share it. This task is to write a blog entry linking to that document.
@mikesmit mikesmit self-assigned this Feb 6, 2025
mikesmit pushed a commit that referenced this issue Feb 6, 2025
API Architecture doc blog post
1fec76e 
fixes #2344
@mikesmit mikesmit linked a pull request Feb 6, 2025 that will close this issue
Open
mikesmit pushed a commit that referenced this issue Feb 6, 2025
API Architecture doc blog post
e99d4aa 
fixes #2344
mikesmit pushed a commit that referenced this issue Feb 6, 2025
API Architecture doc blog post
3065229 
fixes #2344
@mikesmit
Copy link
Collaborator Author

I think this is still waiting on Max to approve so leaving as-is.

@mikesmit
Copy link
Collaborator Author

Ah got a response in slack

Wdyt of posting the full doc rather than linking? Easiest way to do that is post to medium then use mediumexporter per the readme


NEW

[12:44](https://policyengine-group.slack.com/archives/D07NN4T33EW/p1738961061140869?thread_ts=1738958064.136559&cid=D07NN4T33EW)
Could also link to the doc if inviting comments

Taking a look at publishing with mediumexporter.

@mikesmit
Copy link
Collaborator Author

mikesmit commented Feb 10, 2025 •
edited
Loading

Looks like I'd need access to our medium blog so blocked until tomorrow. instructions are here:

policyengine-app/src/posts/README.md

Lines 5 to 9 in 3ceb937

1. Publish a post to Medium (any site will do but preferably blog.policyengine.org).[^1]
2. Ensure `npm install -g mediumexporter` is installed.
3. Run `mediumexporter {url_of_post} > src/posts/articles/{slug}.md`.[^2]
4. Download the cover image from the post and save it to `src/images/posts/articles/{slug}.{ext}`.
5. Add a new entry to `src/posts/posts.json` with the below details (mostly self-explanatory):

mikesmit pushed a commit that referenced this issue Feb 10, 2025
API Architecture doc blog post
95a231e 
fixes #2344
mikesmit pushed a commit that referenced this issue Feb 11, 2025
API Architecture doc blog post
5a79302 
fixes #2344
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@mikesmit mikesmit

Labels
None yet
Projects
policyengine-app
Status: Todo
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

API Architecture doc blog post PolicyEngine/policyengine-app
1 participant
@mikesmit