Skip to content

Conversation

@JPrevost
Copy link
Member

@JPrevost JPrevost commented Jan 23, 2023

Why are these changes being introduced:

  • Genereated documentation will be used alongside our human created docs to create a comprehensive documentation package

Relevant ticket(s):

How does this address that need:

  • Adds documentation to README on how and why to manually create the referenec docs via SpectaQL
  • Adds SpectaQL install and Build to our existing documentation automation

Document any side effects to this change:

  • The SpectaQL config currently points to our v2 GraphQL endpoint to allow us to document the upcoming release. Once released to prod, we should reconfigure the build step to use our prod endpoint.

Developer

  • All new ENV is documented in README
  • All new ENV has been added to Heroku Pipeline, Staging and Prod
  • ANDI or Wave has been run in accordance to
    our guide and
    all issues introduced by these changes have been resolved or opened as new
    issues (link to those issues in the Pull Request details above)
  • Stakeholder approval has been confirmed (or is not needed)

Code Reviewer

  • The commit message is clear and follows our guidelines
    (not just this pull request message)
  • There are appropriate tests covering any new functionality
  • The documentation has been updated or is unnecessary
  • The changes have been verified
  • New dependencies are appropriate or there were no changes

Requires database migrations?

NO

Includes new or updated dependencies?

YES (only as part of automated build process, not as part of core application)

Why are these changes being introduced:

* Genereated documentation will be used alongside our human created
  docs to create a comprehensive documentation package

Relevant ticket(s):

* https://mitlibraries.atlassian.net/browse/TIMX-149

How does this address that need:

* Adds documentation to README on how and why to manually create the
  referenec docs via SpectaQL
* Adds SpectaQL install and Build to our existing documentation
  automation

Document any side effects to this change:

* The SpectaQL config currently points to our v2 GraphQL endpoint to
  allow us to document the upcoming release. Once released to prod,
  we should reconfigure the build step to use our prod endpoint.
@mitlib mitlib temporarily deployed to timdex-pr-639 January 23, 2023 21:47 Inactive
@JPrevost
Copy link
Member Author

The build process succeed but the deploy failed when I tried to run it from this branch. Based on the error, I suspect we can currently only deploy to Pages from the main branch. Longterm that will make sense so I'm hesitant to "fix" it to allow deploying from any branch so I'd suggest we assume that will resolve itself after we merge and we deploy from main. We can discuss whether the workflow should allow deploying from any branch to Pages separately from this work.

@JPrevost JPrevost requested a review from jazairi January 23, 2023 22:09
@JPrevost
Copy link
Member Author

If we want to allow pages to be deployed to from any branch, I believe this is where we'd do that:
https://github.com/MITLibraries/timdex/settings/environments/9748525/edit

Copy link
Contributor

@jazairi jazairi left a comment

Choose a reason for hiding this comment

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

Confirmed that this is working locally. I don't know that PR branch deploys will be necessary, but we can cross that bridge if we come to it.

@JPrevost JPrevost merged commit 27f1a28 into main Jan 25, 2023
@JPrevost JPrevost deleted the timx-149-generate-ref-docs branch January 25, 2023 20:39
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.

4 participants