registry-server icon indicating copy to clipboard operation
registry-server copied to clipboard

New registry infrastructure

Open thomasdavis opened this issue 5 years ago • 11 comments

The old registry server has been to hard to manage and pay for.

We will move the system to a serverless approach which loads a users resume via a public gist named resume.json.

When a request is made to registry.jsonresume.org/thomasdavis it will;

  1. Look up the users gists via the api (If we don't yet know the location of their resume.json gist)
  2. Store the url to the gist in a datastore
  3. Render the resume on a function by hitting the new serverless theme renderer
  • Still need to figure out a convention for users to define which theme they would like rendered by default (property in resume.json, in the gist file extension, in the gist description)

Example gist api response: https://api.github.com/users/thomasdavis/gists

All old registry members should have got an email containing their resume backup, if not, let me know.

thomasdavis avatar Jun 26 '19 04:06 thomasdavis

So registry is up now

https://registry.jsonresume.org/thomasdavis

By creating a resume.json on your github account, you can access it by entering your github username https://registry.jsonresume.org/{github_username}

You can set theme by adding a json blob to your gist description { "theme": "elegant"}

Here is my resume.json -> https://gist.github.com/thomasdavis/c9dcfa1b37dec07fb2ee7f36d7278105

thomasdavis avatar Jun 26 '19 06:06 thomasdavis

  • [ ] Need to store url to gist for github api rates
  • [ ] Need a way to cache bust theme if gist is cached
  • [ ] Need speed improvements
  • [ ] Need better errors
  • [ ] Need to fix documentation
  • [ ] Deprecating publishing from cli tool

thomasdavis avatar Jun 26 '19 06:06 thomasdavis

New serverless code bases can be found

https://github.com/jsonresume/registry-functions https://github.com/jsonresume/theme-functions

All ideas are appreciated!

thomasdavis avatar Jun 26 '19 06:06 thomasdavis

@thomasdavis thanks man. You did it. I needed this badly and since I already have a backup it is easy to make a gist and voila it is working now. :+1: for the theme integration through gist description.

adityatandon007 avatar Jun 26 '19 07:06 adityatandon007

Website hosting instructions updated -> https://jsonresume.org/getting-started/

@adityatandon007 Thanks!

thomasdavis avatar Jun 27 '19 03:06 thomasdavis

I've changed the theme selection to be inside the resume.json instead.

Simply add { "meta": { "theme": "elegant" } } as a top level property of your resume.json

The meta property was added to the official schema to support things like this.

@adityatandon007 you will want to update yours

thomasdavis avatar Jun 27 '19 05:06 thomasdavis

I need to merge theme and registry server into one for speed purposes.

thomasdavis avatar Jul 02 '19 11:07 thomasdavis

Thank you so much for posting this. @thomasdavis could you also update the README as to how to get it to work locally? I have uploaded my resume.json as a gist and saw it work at https://registry.jsonresume.org/ars75

adityasatalkar avatar Jul 22 '19 17:07 adityasatalkar

Works perfect for me. Thanks! https://registry.jsonresume.org/jorgeas80

jorgeas80 avatar Aug 02 '19 15:08 jorgeas80

All ideas are appreciated!

@thomasdavis Since a gist is a collection of files, I made an assumption that broke my resume until I realized what it was. I cloned my gist and added the html output just to have it easily referenced. The current code expects a gist named resume.json having a single file named resume.json. What are your thoughts on finding the file with name resume.json within that gist?

If that is not possible, a cleaner error message would be cool for people who run into this. Let me know if you need the current error message. I'd love to contribute if you approve the change.

dalevross avatar Dec 09 '19 14:12 dalevross

@dalevross Yep I should fix that, hopefully can get to it tonight.

thomasdavis avatar Dec 10 '19 01:12 thomasdavis