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.

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

[DOCS]: Create new docs repository instructions #4

Closed
narcher7 opened this issue Mar 11, 2020 · 0 comments
Closed

[DOCS]: Create new docs repository instructions #4

narcher7 opened this issue Mar 11, 2020 · 0 comments
Assignees

Comments

@narcher7
Copy link
Contributor

Description

In order to add a new section to elastic.co, users must either add their book to a different elastic repository or create a new docs repository.

Either option requires a similar but slightly divergent set of steps. Some of the repo addition processes are documented in the "Creating a new book" page in the docs section of the wiki, but there's no information about configuring a new repository.

Verify the steps required to add a book to an existing Elastic repository and add the additional steps needed to create your own docs repository.

Acceptance Test Criteria

  1. Add a docs directory with the required files to an existing elastic repo.

OR

  1. Create a new repository with a docs directory and the required files.

  2. Modify the conf.yaml and shared attributes files in the elastic/docs repo to call your existing or new repo.

  3. (For new repositories), add your new repository to elastic/infra repo, in order to get the benefits of Elastic's CI/CD system Jenkins.

Notes

  • Add the "Team:Docs" label to new issues.
  • Be sure to add any necessary screenshots for clarity.
  • Include any conditions or caveats that may affect customers.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants