FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

Make the API documentation version not *hardcoded* to v4.9.0 by GabrielBrascher · Pull Request #3247 · apache/cloudstack · GitHub

Repository navigation

Make the API documentation version not *hardcoded* to v4.9.0 - #3247

Merged
yadvr merged 2 commits into
apache:masterfrom
CLDIN:generate-api-documentation-versioned
Mar 29, 2019
Merged

yadvr merged 2 commits into
apache:masterfrom
CLDIN:generate-api-documentation-versioned

Conversation

GabrielBrascher commented Mar 28, 2019 •
edited
Loading

Copy link
Copy Markdown
Member

Currently, the API documentation is hardcoded to v4.9.0. This commit makes the API documentation automatically updated to the current project version. If one wants to set another version, it is possible by just editing the ACS_RELEASE variable in build-apidoc.sh.

Description

Types of changes

  • Breaking change (fix or feature that would cause existing functionality to change)
  • New feature (non-breaking change which adds functionality)
  • Bug fix (non-breaking change which fixes an issue)
  • Enhancement (improves an existing feature and functionality)
  • Cleanup (Code refactoring and cleanup, that may add test cases)

Screenshots (if appropriate):

Prior to the changes proposed in this PR the generated API documentaion was labeled as '4.9.0':

How Has This Been Tested?

Project API documentation page:

Example of an API command documentation page:

Comment thread tools/apidoc/generatecommands.xsl Outdated
<!-- Modify this line for the release version -->
<span>
Apache CloudStack v4.9.0 Root Admin API Reference
Apache CloudStack v%ACS_RELEASE% Root Admin API Reference

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

do we need/want the v? It is always v anyways.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Good point. I agree with you @rafaelweingartner. Updated it!

GabrielBrascher force-pushed the generate-api-documentation-versioned branch 2 times, most recently from 6f71d58 to 94593f8 Compare March 28, 2019 17:31
This commit makes the API documentation automatically updated to the
current project version. If one wants to set another version, it is
possible by just editing the ACS_RELEASE variable in 'build-apidoc.sh'.
GabrielBrascher force-pushed the generate-api-documentation-versioned branch from 94593f8 to 7368cc0 Compare March 28, 2019 17:32
yadvr merged commit 6c841bf into apache:master Mar 29, 2019
pbankonier pushed a commit to pbankonier/cloudstack that referenced this pull request Apr 24, 2019
…apache#3247)

This commit makes the API documentation automatically updated to the
current project version. If one wants to set another version, it is
possible by just editing the ACS_RELEASE variable in 'build-apidoc.sh'.
DaanHoogland mentioned this pull request May 2, 2019
5 tasks
soreana mentioned this pull request Aug 8, 2020
1 of 5 tasks
yadvr pushed a commit that referenced this pull request Aug 10, 2020
apidoc build failed in Mac OS because of sed in-place command. It is a minor change that fixed this issue. More information here

Fixes: #3247
Fixes: #3312
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
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.

3 participants


Back | FazBrowse Home | New Git URL