Fix text search

- Finish docs authoring / migration (first cut)
This commit is contained in:
Daniel J. Summers 2023-01-30 22:12:23 -05:00
parent 2aef50400d
commit 9750f7c044
4 changed files with 175 additions and 104 deletions

View File

@ -24,6 +24,10 @@ let howItWorks : HttpHandler =
let accountHelp : HttpHandler = let accountHelp : HttpHandler =
renderHandler "Accounts | How It Works" Views.Help.accounts renderHandler "Accounts | How It Works" Views.Help.accounts
// GET: /how-it-works/listings
let listingHelp : HttpHandler =
renderHandler "Job Listings | How It Works" Views.Help.listings
// GET: /how-it-works/profiles // GET: /how-it-works/profiles
let profileHelp : HttpHandler = let profileHelp : HttpHandler =
renderHandler "Employment Profiles | How It Works" Views.Help.profiles renderHandler "Employment Profiles | How It Works" Views.Help.profiles
@ -42,6 +46,7 @@ let endpoints =
GET_HEAD [ GET_HEAD [
route "" howItWorks route "" howItWorks
route "/accounts" accountHelp route "/accounts" accountHelp
route "/listings" listingHelp
route "/profiles" profileHelp route "/profiles" profileHelp
] ]
] ]

View File

@ -645,6 +645,76 @@ module Help =
] ]
|> pageWithTitle "How It Works: Accounts" |> pageWithTitle "How It Works: Accounts"
/// Job listings help page
let listings =
[ backToIndex
p [] [
span [ _class "fst-italic" ] [
txt "On this page: "
a [ _href "#creating" ] [ txt "Creating a Job Listing" ]; txt " • "
a [ _href "#maintaining" ] [ txt "Maintaining" ]; txt " • "
a [ _href "#searching" ] [ txt "Searching" ]
]
]
h4 [ _id "creating"; mainHeading ] [ txt "Creating a Job Listing" ]
p [] [
txt "The "; span [ linkedPage] [ txt "My Job Listings" ]; txt " page shows all of the job listings you "
txt "have created. To add a new one, click the "; span [ actionButton] [ txt "Add a New Listing" ]
txt " button. This page allows you to specify a title for the listing; the continent and region; "
txt "whether it is a remote opportunity; the date by which a job needs to be filled; and a full "
txt "description of the position, using "; a [ _href "/how-it-works#markdown" ] [ txt "Markdown" ]
txt ". Once you save the listing, it will be visible to the other citizens here."
]
h4 [ _id "maintaining"; mainHeading ] [ txt "Maintaining and Sharing Your Job Listings" ]
p [] [
txt "The "; span [ linkedPage] [ txt "My Job Listings" ]; txt " page will show you all of your active "
txt "job listings just below the "; span [ actionButton] [ txt "Add a Job Listing" ]; txt " button. "
txt "Within this table, you can edit the listing, view it, or expire it (more on that below). The "
span [ linkedPage] [ txt "View" ]; txt " link will show you the job listing just as other users will "
txt "see it. You can share the link from your browser, and other Jobs, Jobs, Jobs users will be able "
txt "to log on and view it."
]
h5 [] [ txt "Expire a Job Listing" ]
p [] [
txt "Once the job is filled, or the opportunity has passed, you will want to expire the listing; this "
txt "is what the "; span [ linkedPage] [ txt "Expire" ]; txt " link allows you to do. When you click "
txt "it, you will be presented with a single question – was the job filled due to its listing "
txt "here? If not, leave that blank, click the "; span [ actionButton] [ txt "Expire" ]; txt " button, "
txt "and the listing will be expired. If you click that box, though, another Markdown editor will "
txt "appear, where you can share a story of the experience. This is not required, but if you put text "
txt "there, it will be recorded as a Success Story, and other users will be able to read about your "
txt "success."
]
p [] [
txt "Once you have at least one expired job listing, the "; span [ linkedPage] [ txt "My Job Listing" ]
txt " page will have a new section below your active listings, where you can see your expired ones. "
txt "You can still view the expired listing, and links that you may have shared will still pull up the "
txt "listing; there will be an “expired” label beside the title, so that whoever is "
txt "viewing it knows that they are reading about a job that is no longer available."
]
h4 [ _id "searching"; mainHeading] [ txt "Searching Job Listings" ]
p [] [
txt "Active job listings are found on the "; span [ linkedPage ] [ txt "Help Wanted!" ]; txt " page. "
txt "When you first bring up this page, you will see several criteria by which you can narrow your "
txt "results, though none are required. When you click the "; span [ actionButton ] [ txt "Search" ]
txt " button, you will see open job listings filtered by whatever criteria you specified. Each job "
txt "displays its title, its location, whether it is a remote opportunity, and (if specified) the date "
txt "by which the job needs to be filled."
]
p [] [
txt "Clicking the "; span [ linkedPage] [ txt "View" ]; txt " link on a listing brings up the full "
txt "view page for a listing. This page displays all of the information from the search results, along "
txt "with the citizen who posted it, and the full details of the job. All the citizen’s contact "
txt "information is displayed, and you can use any of these means to get in touch with them to inquire "
txt "about the position."
]
]
|> pageWithTitle "How It Works: Job Listings"
/// Profile help page /// Profile help page
let profiles = let profiles =
[ backToIndex [ backToIndex
@ -652,8 +722,9 @@ module Help =
span [ _class "fst-italic" ] [ span [ _class "fst-italic" ] [
txt "On this page: " txt "On this page: "
a [ _href "#creating" ] [ txt "Creating and Editing Your Employment Profile" ] a [ _href "#creating" ] [ txt "Creating and Editing Your Employment Profile" ]
txt " • "; a [ _href "#searching" ] [ txt "Searching Employment Profiles" ]; txt " • " txt " • "; a [ _href "#searching" ] [ txt "Searching" ]; txt " • "
a [ _href "#viewing" ] [ txt "Viewing, Printing, and Sharing Employment Profiles" ] a [ _href "#viewing" ] [ txt "Viewing, Printing, and Sharing" ]; txt " • "
a [ _href "#finding" ] [ txt "Finding Employment" ]
] ]
] ]
@ -780,127 +851,122 @@ module Help =
] ]
h4 [ _id "searching"; mainHeading ] [ txt "Searching Employment Profiles" ] h4 [ _id "searching"; mainHeading ] [ txt "Searching Employment Profiles" ]
h5 [] [ txt "Search Criteria" ]
p [] [ p [] [
txt "The employment profile search form will be slightly different depending on whether there is a " txt "The employment profile search form is the same whether there is a user logged on or not; however, "
txt "user logged on or not. There are " txt "the results are different. There are three sections to the search form. "
strong [] [ txt "Continent" ]; txt " will select profiles from the selected continent, while "
strong [] [ txt "Seeking Remote Work?" ]; txt " will select profiles based whether the citizen has "
txt "selected remote work in their profile. "; strong [] [ txt "Text Search" ]; txt " will search "
txt "several aspects of the employment profile for matches; it is case-insensitive and will match "
txt "partial words (ex. searching for “ing” will match “working”, "
txt "“BEING”, or “singsong”)."
]
p [] [
txt "If more than one field has a value selected, profiles must match all of those selections to be "
txt "returned. Additionally, “Hidden” profiles will never be returned in searches, and "
txt "if no user is logged on, only “Public” and “Anonymous” profiles will be "
txt "considered as candidates for search results."
] ]
// TODO: this is substantially different h5 [] [ txt "Search Results" ]
// h5 Viewing and Sharing Your Profile p [] [
// p. txt "If the visibility of the profile allows you to view it, the first column will contain a "
// Once your profile has been established, the #[span.link My Employment Profile] page will have a button at the bottom span [ linkedPage ] [ txt "View" ]; txt " link. The remaining columns will display other attributes "
// that will let you view your profile the way all other validated users will be able to see it. (There will also be a txt "of the employment profile. In public search results for profiles with “Anonymous” "
// link to this page from the #[span.link Dashboard].) The URL of this page can be shared on any No Agenda-affiliated txt "visibility, the last column of the search results will show the citizen’s skills."
// Mastodon instance, if you would like to share it there. Just as with job listings, existing users will go straight ]
// there, while others will get there once they authorize this application.
// p.
// The name on employment profiles is a link to that user’s profile on their Mastodon instance; from there,
// others can communicate further with you using the tools Mastodon provides.
// h5 “I Found a Job!” h4 [ _id "viewing"; mainHeading ] [ txt "Viewing, Printing, and Sharing Employment Profiles" ]
// p. p [] [
// If your profile indicates that you are seeking employment, and you secure employment, that is something you will txt "An employment profile can be viewed via the "; span [ linkedPage ] [ txt "View" ]; txt " link in "
// want to update (and – congratulations!). From both the #[span.link Dashboard] and txt "search results, and logged-on users can find this view via the "
// #[span.link My Employment Profile] pages, you will see a link that encourages you to tell us about it. Click either span [ actionButton ] [ txt "View Your Employment Profile" ]; txt " button on the "
// of those links, and you will be brought to a page that allows you to indicate whether your employment actually came span [ linkedPage ] [ txt "My Employment Profile" ]; txt " page. The profile view page displays the "
// from someone finding your profile on Jobs, Jobs, Jobs, and gives you a place to write about the experience. These txt "following information in order:"
// stories are only viewable by validated users, so feel free to use as much (or as little) identifying information as ]
// you’d like. You can also submit this page with all the fields blank; in that case, your “Seeking ul [] [
// Employment” flag is cleared, and the blank story is recorded. li [] [
// p. txt "Display Name "; em [] [ txt "(with a tag if the citizen is actively seeking employment)" ]
// As a validated user, you can also view others success stories. Clicking #[span.link Success Stories] in the sidebar ]
// will display a list of all the stories that have been recorded. If there is a story to be read, there will be a link li [] [ txt "Continent / Region" ]
// to read it; if you submitted the story, there will also be an #[span.link Edit] link. li [] [ txt "Contact Information "; em [] [ txt "(only public items if viewing publicly)" ] ]
li [] [ txt "Remote / Full-Time selections" ]
li [] [ txt "Professional Biography" ]
li [] [ txt "Skill list" ]
li [] [ txt "Employment History" ]
li [] [ txt "Experience" ]
]
p [] [
txt "If a user is logged on and is viewing their own profile, there will be an "
span [ actionButton ] [ txt "Edit Your Profile" ]; txt " button at the bottom of the page. Either way, "
txt "there will also be a "; span [ actionButton ] [ txt "View Print Version" ]; txt " button that "
txt "will open a printable version in a new browser tab. This version is constructed the same way as "
txt "the previous page; however, contact information will be fully displayed rather than linked. There "
txt "will be no menu, header, or footer on the page, but there will be a "
span [ actionButton ] [ txt "Print" ]; txt " button at the bottom of the page, which will not show on "
txt "the actual printed version."
]
p [] [
txt "Both the view and print versions may be shared by copying the full URL from the browser’s "
txt "address bar. When using this URL, “Public” visibility profiles will display for "
txt "anyone, while “Anonymous” and “Private” visibility profiles will require "
txt "a citizen to log on first. “Hidden” visibility profiles will return a “page not "
txt "found” error for anyone other than the citizen to which they belong."
]
h4 [ _id "finding"; mainHeading ] [ txt "Finding Employment" ]
p [] [
txt "If your profile indicates that you are seeking employment, and you secure employment, you will "
txt "want to update that (and – congratulations!). From both the "
span [ linkedPage ] [ txt "Dashboard" ]; txt " and the "
span [ linkedPage ] [ txt "General Information" ]; txt " Employment Profile pages, you will see a link "
txt "that encourages you to tell us about it. Click either of those links, and you will be brought to "
txt "a page that allows you to indicate whether your employment actually came from hosting your "
txt "employment profile on Jobs, Jobs, Jobs, and gives you a place to write about the experience. "
txt "These stories are only viewable by logged-on citizens, so feel free to use as much (or as little) "
txt "identifying information as you’d like. You can also submit this page with all the fields "
txt "blank; in that case, your “Seeking Employment” flag is cleared, and the blank story "
txt "is recorded."
]
p [] [
txt "As a validated user, you can also view others’ success stories from both their employment "
txt "profiles or job listings. Clicking "; span [ linkedPage ] [ txt "Success Stories" ]; txt " in the "
txt "sidebar will display a list of all the stories that have been recorded. If there is a story to be "
txt "read, there will be a link to read it; if you submitted the story, there will also be an "
span [ linkedPage ] [ txt "Edit" ]; txt " link."
]
] ]
|> pageWithTitle "How It Works: Employment Profiles" |> pageWithTitle "How It Works: Employment Profiles"
/// Online help / documentation index page /// Online help / documentation index page
let index = let index =
pageWithTitle "How It Works" [ article [] [
h5 [ _class "pb-3 text-muted fst-italic" ] [ txt "Last Updated January 22<sup>nd</sup>, 2023" ] h3 [ _class "mb-0" ] [ txt "How It Works" ]
h6 [ _class "mb-3 text-muted fst-italic" ] [ txt "Last Updated January 22<sup>nd</sup>, 2023" ]
p [ _class "fst-italic" ] [ p [ _class "fst-italic" ] [
txt "Show me how to "; a [ _href "#listing-search" ] [ txt "find a job" ]; txt " &bull; " txt "Show me how to "; a [ _href "/how-it-works/listings#searching" ] [ txt "find a job" ]
a [ _href "#listing" ] [ txt "list a job opportunity" ]; txt " &bull; " txt " &bull; "; a [ _href "/how-it-works/listings#creating" ] [ txt "list a job opportunity" ]
a [ _href "#profile-search" ] [ txt "find people to hire" ]; txt " &bull; " txt " &bull; "; a [ _href "/how-it-works/profiles#searching" ] [ txt "find people to hire" ]
a [ _href "#profile" ] [ txt "create an employment profile" ] txt " &bull; "; a [ _href "/how-it-works/profiles#creating" ] [ txt "create an employment profile" ]
] ]
p [] [ p [] [
strong [] [ a [ _href "/how-it-works/accounts" ] [ txt "Accounts" ] ]; br [] strong [] [ a [ _href "/how-it-works/accounts" ] [ txt "Accounts" ] ]; br []
txt "How to sign up as a user, get logged on, update your information, or remove your account" txt "How to sign up as a user, get logged on, update your information, or remove your account"
] ]
p [] [
strong [] [ a [ _href "/how-it-works/listings" ] [ txt "Job Listings" ] ]; br []
txt "Creating, maintaining, and sharing job opportunities with fellow citizens"
]
p [] [ p [] [
strong [] [ a [ _href "/how-it-works/profiles" ] [ txt "Employment Profiles" ] ]; br [] strong [] [ a [ _href "/how-it-works/profiles" ] [ txt "Employment Profiles" ] ]; br []
txt "Creating, updating, and sharing your own employment profile; and searching, viewing, and printing " txt "Creating, updating, and sharing your own employment profile; and searching, viewing, and printing "
txt "profiles for yourself or your fellow citizens" txt "profiles for yourself or your fellow citizens"
] ]
h4 [ _id "listing-search"; mainHeading] [ txt "Find a Job Listing" ]
p [] [
txt "Active job listings are found on the "; span [ linkedPage ] [ txt "Help Wanted!" ]; txt " page. When "
txt "you first bring up this page, you will see several criteria by which you can narrow your results, "
txt "though none are required. When you click the "; span [ actionButton ] [ txt "Search" ]; txt " button, "
txt "you will see open job listings filtered by whatever criteria you specified. Each job displays its "
txt "title, its location, whether it is a remote opportunity, and (if specified) the date by which the job "
txt "needs to be filled."
]
p [] [
txt "Clicking the "; span [ linkedPage] [ txt "View" ]; txt " link on a listing brings up the full view "
txt "page for a listing. This page displays all of the information from the search results, along with the "
txt "citizen who posted it, and the full details of the job. All the citizen&rsquo;s contact information "
txt "is displayed, and you can use any of these means to get in touch with them to inquire about the "
txt "position."
]
h4 [ _id "listing"; mainHeading ] [ txt "Job Listings" ]
h5 [] [ txt "Create a Job Listing" ]
p [] [
txt "The "; span [ linkedPage] [ txt "My Job Listings" ]; txt " page shows all of the job listings you "
txt "have created. To add a new one, click the "; span [ actionButton] [ txt "Add a New Listing" ]
txt " button. This page allows you to specify a title for the listing; the continent and region; whether "
txt "it is a remote opportunity; the date by which a job needs to be filled; and a full description of the "
txt "position, using "; a [ _href "#markdown" ] [ txt "Markdown" ]; txt ". Once you save the listing, it "
txt "will be visible to the other citizens here."
]
h5 [] [ txt "Maintain and Share Your Job Listings" ]
p [] [
txt "The "; span [ linkedPage] [ txt "My Job Listings" ]; txt " page will show you all of your active job "
txt "listings just below the "; span [ actionButton] [ txt "Add a Job Listing" ]; txt " button. Within "
txt "this table, you can edit the listing, view it, or expire it (more on that below). The "
span [ linkedPage] [ txt "View" ]; txt " link will show you the job listing just as other users will see "
txt "it. You can share the link from your browser, and Jobs, Jobs, Jobs users will be able to log on and "
txt "view it."
]
h5 [] [ txt "Expire a Job Listing" ]
p [] [
txt "Once the job is filled, or the opportunity has passed, you will want to expire the listing; this is "
txt "what the "; span [ linkedPage] [ txt "Expire" ]; txt " link allows you to do. When you click it, you "
txt "will be presented with a single question &ndash; was the job filled due to its listing here? If not, "
txt "leave that blank, click the "; span [ actionButton] [ txt "Expire" ]; txt " button, and the listing "
txt "will be expired. If you click that box, though, another Markdown editor will appear, where you can "
txt "share a story of the experience. This is not required, but if you put text there, it will be recorded "
txt "as a Success Story, and other users will be able to read about your success."
]
p [] [
txt "Once you have at least one expired job listing, the "; span [ linkedPage] [ txt "My Job Listing" ]
txt " page will have a new section below your active listings, where you can see your expired ones. You "
txt "can still view the expired listing, and links that you may have shared will still pull up the "
txt "listing; there will be an &ldquo;expired&rdquo; label beside the title, so that whoever is viewing it "
txt "knows that they are reading about a job that is no longer available."
]
h4 [ _id "profile-search"; mainHeading ] [ txt "Searching Profiles" ]
p [] [
txt "The "; span [ linkedPage] [ txt "Employment Profiles"]; txt " link at the side allows you to search "
txt "for profiles by continent, the citizen&rsquo;s desire for remote work, a skill, or any text in their "
txt "professional biography and experience. If you find someone with whom you&rsquo;d like to discuss "
txt "potential opportunities, their contact information is displayed below their name at the top of the "
txt "profile."
]
h4 [ _id "profile"; mainHeading ] [ txt "Your Employment Profile" ]
h4 [ _id "markdown"; mainHeading ] [ txt "A Bit about Markdown" ] h4 [ _id "markdown"; mainHeading ] [ txt "A Bit about Markdown" ]
p [] [ p [] [
txt "Markdown is a plain-text way to specify formatting quite similar to that provided by word processors. " txt "Markdown is a plain-text way to specify formatting quite similar to that provided by word processors. "

View File

@ -64,7 +64,7 @@ let search (search : ProfileSearchForm) isPublic = backgroundTask {
if search.RemoteWork <> "" then if search.RemoteWork <> "" then
"p.data ->> 'isRemote' = @remote", [ "@remote", jsonBool (search.RemoteWork = "yes") ] "p.data ->> 'isRemote' = @remote", [ "@remote", jsonBool (search.RemoteWork = "yes") ]
if search.Text <> "" then if search.Text <> "" then
" p.data ->> 'region' ILIKE @text "( p.data ->> 'region' ILIKE @text
OR p.data ->> 'biography' ILIKE @text OR p.data ->> 'biography' ILIKE @text
OR p.data ->> 'experience' ILIKE @text OR p.data ->> 'experience' ILIKE @text
OR EXISTS ( OR EXISTS (
@ -74,7 +74,7 @@ let search (search : ProfileSearchForm) isPublic = backgroundTask {
SELECT 1 FROM jsonb_array_elements(p.data['history']) x(elt) SELECT 1 FROM jsonb_array_elements(p.data['history']) x(elt)
WHERE x ->> 'employer' ILIKE @text WHERE x ->> 'employer' ILIKE @text
OR x ->> 'position' ILIKE @text OR x ->> 'position' ILIKE @text
OR x ->> 'description' ILIKE @text)", OR x ->> 'description' ILIKE @text))",
[ "@text", like search.Text ] [ "@text", like search.Text ]
] ]
let vizSql = let vizSql =

View File

@ -45,7 +45,7 @@ let edit (profile : Profile) =
if hasProfile then if hasProfile then
p [] [ p [] [
a [ _class "btn btn-primary"; _href $"/profile/{CitizenId.toString profile.Id}/view" ] [ a [ _class "btn btn-primary"; _href $"/profile/{CitizenId.toString profile.Id}/view" ] [
i [ _class "mdi mdi-file-account-outline" ] []; txt "&nbsp; View Your User Profile" i [ _class "mdi mdi-file-account-outline" ] []; txt "&nbsp; View Your Employment Profile"
] ]
] ]
hr [] hr []