Skip to content

I updated the DocBox version to use the v5.0.2#346

Open
DavisVega1990 wants to merge 3 commits into
developmentfrom
update_DocBox_version_dvega
Open

I updated the DocBox version to use the v5.0.2#346
DavisVega1990 wants to merge 3 commits into
developmentfrom
update_DocBox_version_dvega

Conversation

@DavisVega1990
Copy link
Copy Markdown
Contributor

Description

Please include a summary of the changes and which issue(s) is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.

Please note that all PRs must have tests attached to them

Type of change

Updated the DocBox version to use v5.0.2 to improve the UI and the SEO requirements

Please delete options that are not relevant.

  • Improvement

Checklist

  • I have made corresponding changes to the documentation

@DavisVega1990
Copy link
Copy Markdown
Contributor Author

Dashboard-DocBox

Comment thread apidocs/index.cfm Outdated
}
);
docbox = new docbox.DocBox()
.addStrategy( "HTML", {
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

@DavisVega1990 This is wrong. Why did you change the strategy? That's not the right one. The command docs needs to use the actual CommandBox strategy

Comment thread build/build.xml

<!-- Zip API Docs -->
<zip destfile="${dist.dir}/${distro.name}-apidocs-${commandbox.version}.zip" basedir="${temp.dir}/apidocs"></zip>
<zip destfile="${dist.dir}/${distro.name}-apidocs-${commandbox.version}.zip" basedir="${temp.dir}/apidocs/CommandBox-CommandDocs"></zip>
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Why did you change this directory?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I updated the directory name because, when I switched to DocBox version 5 in the tests I ran with the incorrect Strategy = HTML, the project returned the error message: "The directory CommandBox-CommandDocs does not exist." This meant the directory had to be created before generating the files.

For this reason, I set the directory name as a prerequisite to generating the files.

Comment thread apidocs/box.json Outdated
},
"devDependencies":{

"docbox":"https://github.com/Ortus-Solutions/DocBox/archive/v5.0.2.zip"
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Please change this to use a proper Forgebox slug@vesrion. I'm not even sure why it was using a direct URL to start.

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