SPP12087 help centre structure refactor #385
Conversation
… to build the help centre navigation and build on demand instead Signed-off-by: jasonbellONS <jason.bell@ons.gov.uk>
Signed-off-by: jasonbellONS <jason.bell@ons.gov.uk>
Signed-off-by: jasonbellONS <jason.bell@ons.gov.uk>
…ilt each time a help centre page is accessed Signed-off-by: jasonbellONS <jason.bell@ons.gov.uk>
Signed-off-by: jasonbellONS <jason.bell@ons.gov.uk>
Signed-off-by: jasonbellONS <jason.bell@ons.gov.uk>
Signed-off-by: jasonbellONS <jason.bell@ons.gov.uk>
Signed-off-by: jasonbellONS <jason.bell@ons.gov.uk>
|
Note failing tests due to changes in ordering of the content, should be resolved under https://jira.ons.gov.uk/browse/SPP-11740 |
There was a problem hiding this comment.
Not reviewed the code yet, but could we try and maintain URLs. When I load help centre pages in the dev server they have a different URL to what we currently had deployed. E.g:
Find and view methods
prod :
dev :
If you could check the pages and try and get them to align that'd be good.
… consistent Signed-off-by: jasonbellONS <jason.bell@ons.gov.uk>
Signed-off-by: jasonbellONS <jason.bell@ons.gov.uk>
Hi, this should now be fixed |
There was a problem hiding this comment.
A few questions and some minor comments.
Also I notice the live site doesn't have Help Centre Index in Alphabetical order:
I vaguely recall this may have been a bug we noticed in the last deploy that was since fixed (i.e made alphabetical) - just checking the change is expected?
sml_builder/__init__.py
Outdated
| "label": "Submit a method request", | ||
| } | ||
| ) | ||
| nav["categories"] = sorted(nav["categories"], key=lambda x: x["name"]) |
There was a problem hiding this comment.
Could we add a comment here just to call out sorting is done in code (rather than in contentful)
sml_builder/__init__.py
Outdated
| category["subcategories"] = sorted( | ||
| category["subcategories"], key=lambda x: x["label"] | ||
| ) | ||
| app.cache["help_centre_nav"] = nav |
There was a problem hiding this comment.
Where does this cache live? If someone navigates to the website and we deploy a new version of the website how does the cache get refreshed?
There was a problem hiding this comment.
cache is a dictionary object within the flask application object, each time we deploy that application will be recreated, so in the case of this method we deploy, and during the first request to it we create this navigation and add it to the cache dictionary, it will remain here unless deleted or the app is stopped
If i remember correctly it was the methods page that was made alphabetical, i made a similar change here as you can't ensure that content is gathered in a specific order, my thoughts were displaying it alphabetically made most sense |
Signed-off-by: jasonbellONS <jason.bell@ons.gov.uk>
|
@gibbardsteve comments added where requested |
|
Oh right yes thats my mistake, during the freeze process the freeze module would make requests to each page in order to build that page and freeze it, so this process would be happening during that build step |
Signed-off-by: jasonbellONS <jason.bell@ons.gov.uk>
|
DEPLOY_URL=https://d1uzhgtw86gcqp.cloudfront.net/ |
Help centre refactored to no longer pull in the structure page from contentful, structure and navigation built on demand using information from the other help centre pages grabbed from contentful