Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Gh-364: New getting started guide #370

Merged
merged 22 commits into from
Aug 22, 2023
Merged

Gh-364: New getting started guide #370

merged 22 commits into from
Aug 22, 2023

Conversation

tb06904
Copy link
Member

@tb06904 tb06904 commented Aug 16, 2023 •
edited
Loading

Added a new getting started guide with a basic Gaffer deployment example using Accumulo.

Pages added:

  • Gaffer Basics
  • Quickstart
  • Example Deployement

Done a slight restructure of existing pages to make a new advance user guide section which is still under construction and should probably be another ticket.

New structure of pages:

Getting Started
|_____ Gaffer Basics
|_____ Quickstart
|_____ Example Deployment
|       |____ Project Setup
|       |____ Writing the Schema
|       |____ Running the Deployment
|       |____ Using the API
|_____ Advanced User Guide
        |____ Aggregation
        |____ Import and Export
        |       |____ CSV
        |____ Cardinality

Related Issue

@tb06904 tb06904 linked an issue Aug 16, 2023 that may be closed by this pull request
New getting started guide for the v2 docs #364
Closed
@CLAassistant
Copy link

CLAassistant commented Aug 16, 2023 •
edited
Loading

CLA assistant check
All committers have signed the CLA.

@GCHQDeveloper314 GCHQDeveloper314 changed the title Gh 364 new getting started guide Gh-364: New getting started guide Aug 21, 2023
GCHQDeveloper314
GCHQDeveloper314 reviewed Aug 21, 2023
View reviewed changes
Copy link
Member

@GCHQDeveloper314 GCHQDeveloper314 left a comment

Choose a reason for hiding this comment

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

Some minor comments

docs/getting-started/basics.md Outdated Show resolved Hide resolved
docs/getting-started/basics.md Outdated Show resolved Hide resolved
docs/getting-started/basics.md Outdated Show resolved Hide resolved
docs/getting-started/example-deployment/project-setup.md Outdated Show resolved Hide resolved
docs/getting-started/example-deployment/project-setup.md Outdated Show resolved Hide resolved
docs/getting-started/example-deployment/using-the-api.md Outdated Show resolved Hide resolved
@GCHQDeveloper314 GCHQDeveloper314 merged commit 63ce998 into v2docs Aug 22, 2023
1 check passed
@GCHQDeveloper314 GCHQDeveloper314 deleted the gh-364-new-getting-started-guide branch August 22, 2023 16:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@GCHQDeveloper314 GCHQDeveloper314 GCHQDeveloper314 approved these changes

@l46978 l46978 l46978 approved these changes

@cn337131 cn337131 Awaiting requested review from cn337131

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

New getting started guide for the v2 docs
5 participants
@tb06904 @CLAassistant @GCHQDeveloper314 @cn337131 @l46978