Skip to content

prep release and DATAUP-706-doc-startup#101

Merged
1 commit merged intodevelopfrom
DATAUP-731-prep-release
Mar 3, 2022
Merged

prep release and DATAUP-706-doc-startup#101
1 commit merged intodevelopfrom
DATAUP-731-prep-release

Conversation

@ghost
Copy link
Copy Markdown

@ghost ghost commented Mar 2, 2022

  • I updated the README.md docs to reflect this change.

For changes to the codebase:

  • I have written tests to cover this change.
  • This is not a breaking API change OR
  • This is a breaking API change and I have incremented the API version and added a summary to CHANGELOG.md.

@ghost ghost requested a review from ialarmedalien as a code owner March 2, 2022 22:57
Comment thread README.md
* Wait for response from auth, workspace, and arangodb services, as they are set up
* Specs are set up. Either the repo specs or remote specs are loaded into the specs root path
* Collections, views, and analyzers from the specs are added to the ArangoDB server. If the collection, view, or analyzer already exists, but in a different configuration, it will _not_ be overwritten.
* Collections, views, and analyzers from the loaded specs are compared to those on the ArangoDB server. If the loaded specs' attributes are not recursively a subset of the server specs, then an exception is raise. (This is just preliminary validation behavior.)
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

an exception is raised

I'd incorporate the last sentence into the previous two, so you have something like:

Basic validation of the collections, views, and analyzers is performed by comparing the loaded specs to those on the ArangoDB server. If the loaded specs' attributes are not recursively a subset of the server specs, an exception is raised and ... (server start up fails? what happens if there's an exception?)

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

Ok ... that sounds good ... but I'm gonna call perfect is the opposite of good

@ghost ghost merged commit 14900f2 into develop Mar 3, 2022
@ghost ghost deleted the DATAUP-731-prep-release branch March 3, 2022 17:13
This pull request was closed.
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.

1 participant