Skip to content
This repository was archived by the owner on Nov 24, 2025. It is now read-only.

Fix ordering in overview docs section#3906

Merged
ocket8888 merged 2 commits into
apache:masterfrom
mhoppa:bug/fix_doc_ordering
Sep 6, 2019
Merged

Fix ordering in overview docs section#3906
ocket8888 merged 2 commits into
apache:masterfrom
mhoppa:bug/fix_doc_ordering

Conversation

@mhoppa
Copy link
Copy Markdown
Contributor

@mhoppa mhoppa commented Sep 6, 2019

What does this PR (Pull Request) do?

Fix ordering in overview docs section

Introduction was not first which makes it confusing to the end user as they come in

  • This is not related to any Issue

Which Traffic Control components are affected by this PR?

  • Documentation

What is the best way to verify this PR?

Build docs locally and look at ordering of overview section

If this is a bug fix, what versions of Traffic Control are affected?

The following criteria are ALL met by this PR

  • This PR does not include tests
  • This PR includes documentation
  • This PR does not include an update to CHANGELOG.md as such an update is not necessary
  • This PR includes any and all required license headers
  • This PR does not include a database migration
  • This PR DOES NOT FIX A SERIOUS SECURITY VULNERABILITY (see the Apache Software Foundation's security guidelines for details)

@asf-ci
Copy link
Copy Markdown
Contributor

asf-ci commented Sep 6, 2019

Refer to this link for build results (access rights to CI server needed):
https://builds.apache.org/job/trafficcontrol-PR/4207/
Test PASSed.

@mitchell852 mitchell852 added the documentation related to documentation label Sep 6, 2019
Comment thread docs/source/overview/index.rst Outdated
Comment thread docs/source/overview/index.rst Outdated
Comment thread docs/source/overview/index.rst Outdated
@ocket8888 ocket8888 self-assigned this Sep 6, 2019
Copy link
Copy Markdown
Contributor

@ocket8888 ocket8888 left a comment

Choose a reason for hiding this comment

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

The maxdepth thing didn't work - not sure why - but other than that this compiles without warnings and has the desired effect.

@ocket8888 ocket8888 merged commit 592c6ae into apache:master Sep 6, 2019
@asf-ci
Copy link
Copy Markdown
Contributor

asf-ci commented Sep 6, 2019

Refer to this link for build results (access rights to CI server needed):
https://builds.apache.org/job/trafficcontrol-PR/4208/
Test PASSed.

@mhoppa mhoppa deleted the bug/fix_doc_ordering branch September 6, 2019 20:40
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

documentation related to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants