Skip to content

Next Job documentation Update #168

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

Merged
merged 3 commits into from
Nov 5, 2021
Merged

Next Job documentation Update #168

merged 3 commits into from
Nov 5, 2021

Conversation

rehrenfeld
Copy link
Contributor

No description provided.

NextJob.md Outdated
Comment on lines 94 to 100
"salary": {
"currency": "USD",
"percentile_10": 10.0,
"percentile_90": 14.0,
"period": "YEAR"
},
"active_job_count": 0,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"salary": {
"currency": "USD",
"percentile_10": 10.0,
"percentile_90": 14.0,
"period": "YEAR"
},
"active_job_count": 0,
"salary": {
"currency": "USD",
"percentile_10": 45000.0,
"percentile_90": 110000.0,
"period": "YEAR"
},
"active_job_count": 561,

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's give this slightly more realistic values.

NextJob.md Outdated
Comment on lines 140 to 145
"currency": "USD",
"percentile_10": 10.0,
"percentile_90": 14.0,
"period": "YEAR"
},
"active_job_count": 12,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"currency": "USD",
"percentile_10": 10.0,
"percentile_90": 14.0,
"period": "YEAR"
},
"active_job_count": 12,
"currency": "USD",
"percentile_10": 52000.0,
"percentile_90": 134000.0,
"period": "YEAR"
},
"active_job_count": 128,

NextJob.md Outdated
@@ -47,17 +80,24 @@ for more information about carotene classification and carotene IDs.

## Response Structure

The response consist of a `carotene_id`, `carotene_title`, and list of `skills` for the requested
The response consist of a `carotene_id`, `carotene_title`, `carotene_description`, `salary`,`active_job_count` and list of `skills` for the requested
`carotene_id`. Each item in the `skills` list contains `term`, `id` strings, and `description`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Skills now have types.

NextJob.md Outdated
`carotene_id`. Each item in the `skills` list contains `term`, `id` strings, and `description`
strings as well as list of links to relevant videos. The `next_jobs` sections is
a list consisting of objects containing a `carotene_id` and `carotene_title` string for the next job
as well as a list of `common_skills` and list of `missing_skills`.
a list consisting of objects containing a `carotene_id`, `carotene_title`, `carotene_description`, associated `confidence` to carotene, `salary`,`active_job_count` and string for the next job as well as a list of `common_skills` and list of `missing_skills`.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
a list consisting of objects containing a `carotene_id`, `carotene_title`, `carotene_description`, associated `confidence` to carotene, `salary`,`active_job_count` and string for the next job as well as a list of `common_skills` and list of `missing_skills`.
a list consisting of objects containing a `carotene_id`, `carotene_title`, `carotene_description`, `confidence`, `salary`,`active_job_count` and string for the next job as well as a list of `common_skills` and list of `missing_skills`.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed

NextJob.md Outdated
set of skills associated with the requested carotene ID, as well as the skills the carotene ID has
in common with its next jobs and the missing skills a person should acquire to pursue the next job.
Moreover, for each job we provide active jobs count based on location passed to the endpoint.
Salary will be provided based on criteria :
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Salary will be provided based on criteria :
Salary will be provided based on the following criteria:

@MalarCB
Copy link
Contributor

MalarCB commented Nov 4, 2021

@glpayson Still v1 is in use, don't we want to create NextJobV2.md?

@glpayson
Copy link
Contributor

glpayson commented Nov 5, 2021

@glpayson Still v1 is in use, don't we want to create NextJobV2.md?

I'd rather not tbh. We typically treat earlier versions as deprecated and don't keep old documentation around for it. I guess if we really wanted to we could link to the older version of the documentation like this.

@glpayson glpayson merged commit ca2e266 into master Nov 5, 2021
@rehrenfeld rehrenfeld deleted the 29-10-Update-next-job-doc branch April 21, 2023 09:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants