Adding Search Feature to Fed-Content Site (Future)

[jashlu]

Unlike other Project Portal Sites, the Federal Project Portal does not currently feature the Search functionality, as it hasn't been requested by our federal partners.

To add the Search feature/Search page to the federal site, follow these instructions:

1. Add a new search.json file inside the /content/page/ directory. Here's a sample of what the file should look like:

{
  "templateKey": "SearchPage",
  "title": "Search",
  "image": "about.jpg"

}

2. Update the navbar configurations in the content/config/layout.json file to include 'Search'. This will make the Search page appear on the navbar and be clickable, directing users to the Search page. Modify the navbar section in layout.json as follows:

The navbar section in layout.json should now look like this

"navbar": {
    "title": "North Carolina Project Portal",
    "pages": [
      {
        "name": "Open opportunities",
        "link": "/",
        "show": true
      },
      {
        "name": "In-progress projects",
        "link": "/ongoing/",
        "show": true
      },
      {
        "name": "Completed projects",
        "link": "/completed/",
        "show": true
      },
      {
        "name": "About",
        "link": "/about/",
        "show": true
      },
      {
        "name": "Contact",
        "link": "/contact/",
        "show": true
      },
      {
        "name": "Search",
        "link": "/search/",
        "show": true
      }
    ]
  },

3. Finally, update the .gitignore file to include the three files that will be generated as part of creating the static index for the Search functionality:

# ignore files generated for the site search
static/documents.json
static/documents-reduced.json
static/lunr-index.json

You can reference this PR from the nc project portal site where we go through the same steps featured above to add the Search functionality into the site.
https://github.com/thepolicylab-projectportals/nc-content/pull/614/files