Skip to content
This repository has been archived by the owner on Oct 24, 2023. It is now read-only.

docs: restructure the documentation #253

Merged
merged 1 commit into from
Jan 11, 2019
Merged

docs: restructure the documentation #253

merged 1 commit into from
Jan 11, 2019

Conversation

bacongobbler
Copy link
Contributor

This PR restructures the documentation to make it more clear to the reader where to find relevant information.

Requirements:

@acs-bot
Copy link

acs-bot commented Jan 8, 2019

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: bacongobbler
To fully approve this pull request, please assign additional approvers.
We suggest the following additional approver: jackfrancis

If they are not already assigned, you can assign the PR to them by writing /assign @jackfrancis in a comment when ready.

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@bacongobbler bacongobbler force-pushed the docs-restructure branch 2 times, most recently from 014b4c1 to ab75a5c Compare January 8, 2019 22:09
@CecileRobertMichon
Copy link
Contributor

opinion: the conventional commit message should be docs:

@bacongobbler bacongobbler changed the title WIP: chore: docs restructure WIP: docs: docs restructure Jan 8, 2019
@bacongobbler
Copy link
Contributor Author

fix'd

@bacongobbler bacongobbler changed the title WIP: docs: docs restructure WIP: docs: restructure the documentation Jan 8, 2019
@jackfrancis
Copy link
Member

@bacongobbler Does this include the RDD PR w/ UX aspirations? Or is this just a reorganization, and can be reviewed for immediate merging? (i.e., the language here is all correct)

@bacongobbler
Copy link
Contributor Author

Just a re-org.

@jackfrancis
Copy link
Member

I like this. Reading through the docs, there's some errata that you inherited. Let's merge this and fix that stuff in follow-up PRs.

Thanks!

@jackfrancis jackfrancis changed the title WIP: docs: restructure the documentation docs: restructure the documentation Jan 9, 2019
@jackfrancis
Copy link
Member

requesting feedback from @CecileRobertMichon, @tariq1890, and/or @mboersma

tariq1890
tariq1890 reviewed Jan 9, 2019
View reviewed changes
docs/topics/extensions.md Outdated Show resolved Hide resolved
tariq1890
tariq1890 reviewed Jan 9, 2019
View reviewed changes
docs/topics/extensions.md Outdated Show resolved Hide resolved
@tariq1890
Copy link
Contributor

tariq1890 commented Jan 9, 2019 •
edited
Loading

@bacongobbler Thanks :). I've left review comments

tariq1890
tariq1890 reviewed Jan 9, 2019
View reviewed changes
README.md Outdated Show resolved Hide resolved
@bacongobbler bacongobbler force-pushed the docs-restructure branch 2 times, most recently from 39d44a6 to 0aae714 Compare January 9, 2019 04:29
jackfrancis
jackfrancis reviewed Jan 9, 2019
View reviewed changes
README.md Outdated Show resolved Hide resolved
jackfrancis
jackfrancis reviewed Jan 9, 2019
View reviewed changes
README.md Show resolved Hide resolved
@codecov
Copy link

codecov bot commented Jan 9, 2019

Codecov Report

Merging #253 into master will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master     #253   +/-   ##
=======================================
  Coverage   53.25%   53.25%           
=======================================
  Files          95       95           
  Lines       14246    14246           
=======================================
  Hits         7586     7586           
  Misses       5995     5995           
  Partials      665      665

@bacongobbler bacongobbler force-pushed the docs-restructure branch 2 times, most recently from e2d239e to 800eabd Compare January 9, 2019 19:35
CecileRobertMichon
CecileRobertMichon reviewed Jan 9, 2019
View reviewed changes
Copy link
Contributor

@CecileRobertMichon CecileRobertMichon left a comment

Choose a reason for hiding this comment

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

This is really great, love the way you simplified organization of the docs. Left a few comments.

docs/community/developer-guide.md Show resolved Hide resolved
@CecileRobertMichon
Copy link
Contributor

This lgtm, pending review from other reviewers

jackfrancis
jackfrancis reviewed Jan 10, 2019
View reviewed changes
README.md Outdated Show resolved Hide resolved
tariq1890
tariq1890 reviewed Jan 10, 2019
View reviewed changes
docs/community/README.md Outdated Show resolved Hide resolved
tariq1890
tariq1890 reviewed Jan 10, 2019
View reviewed changes
docs/community/README.md Outdated Show resolved Hide resolved
tariq1890
tariq1890 reviewed Jan 10, 2019
View reviewed changes
docs/topics/README.md Outdated Show resolved Hide resolved
@tariq1890
Copy link
Contributor

Reviewed :) .

@bacongobbler bacongobbler force-pushed the docs-restructure branch 2 times, most recently from 475d536 to d0e5a2c Compare January 10, 2019 19:10
@jackfrancis
Copy link
Member

lgtm

@jackfrancis
docs: restructure the documentation
2ad225e 
This PR restructures the documentation to make it more clear to the
reader where to find relevant information.

Signed-off-by: Matthew Fisher <matt.fisher@microsoft.com>
@jackfrancis jackfrancis mentioned this pull request Jan 10, 2019
Merged
4 tasks
@bacongobbler
Copy link
Contributor Author

looks like an unrelated e2e flake. Shall I merge this in?

@tariq1890
Copy link
Contributor

@bacongobbler. Please do :). Thank you so much for this PR.

@bacongobbler bacongobbler merged commit 077f396 into Azure:master Jan 11, 2019
@bacongobbler bacongobbler deleted the docs-restructure branch January 11, 2019 16:56
@bacongobbler bacongobbler mentioned this pull request Jan 11, 2019
Merged
jackfrancis pushed a commit that referenced this pull request Jan 11, 2019
@jackfrancis
docs: restructure the documentation (#253)
fc155dd 
This PR restructures the documentation to make it more clear to the
reader where to find relevant information.

Signed-off-by: Matthew Fisher <matt.fisher@microsoft.com>
juhacket pushed a commit to juhacket/aks-engine that referenced this pull request Mar 14, 2019
docs: restructure the documentation (Azure#253)
38c6e7a 
This PR restructures the documentation to make it more clear to the
reader where to find relevant information.

Signed-off-by: Matthew Fisher <matt.fisher@microsoft.com>
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@CecileRobertMichon CecileRobertMichon CecileRobertMichon left review comments

@tariq1890 tariq1890 tariq1890 left review comments

@jackfrancis jackfrancis jackfrancis left review comments

Assignees
No one assigned
Labels
area/docs size/XL
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@bacongobbler @acs-bot @CecileRobertMichon @jackfrancis @tariq1890