Improvements to documentation around getting Developer Docs running locally #4875
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
We can give a hint to the user as to how to fix the following
issue:
```
== Request: /document-types/landing_page.html
error build/document-types/landing_page.html
undefined method `include?' for nil
/govuk/govuk-developer-docs/app/document_types.rb:83:in `block in shift_low_value_schemas'
/govuk/govuk-developer-docs/app/document_types.rb:82:in `each'
/govuk/govuk-developer-docs/app/document_types.rb:82:in `shift_low_value_schemas'
/govuk/govuk-developer-docs/app/document_types.rb:74:in `schemas'
/govuk/govuk-developer-docs/source/templates/document_type_template.html.md.erb:28:in `__tilt_29200'
/root/.rbenv/versions/3.3.1/lib/ruby/gems/3.3.0/gems/tilt-2.0.11/lib/tilt/template.rb:181:in `call'
/root/.rbenv/versions/3.3.1/lib/ruby/gems/3.3.0/gems/tilt-2.0.11/lib/tilt/template.rb:181:in `evaluate'
/root/.rbenv/versions/3.3.1/lib/ruby/gems/3.3.0/gems/tilt-2.0.11/lib/tilt/template.rb:109:in `render'
```
App dependency install, build script and startup scripts seemed oddly dispersed throughout the README, making it difficult to talk about shared logic such as the ENV variables. I've consolidated these into their own "Run the app locally" section. Other things to note: - I added `--verbose` to the build script, as the build initially failed for me and I had to re-run the script with verbose mode to see any meaningful output. The output isn't much more verbose than without the flag, so there seems no downside. - I removed the section on `.env` file, as it seems to be an implementation detail, and also incompatible with running via govuk-docker. But I'd like to revisit this. - I'm currently able to compile the website fine, and fetch the remote docs, but am struggling to get the app to _run_ locally (in govuk-docker). - I'd very much like to remove the "docker-compose.yml" hack workaround.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.