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.

Sign up for GitHub

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

Jump to bottom

DOC-12742 quieten jira: macro #799

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

DOC-12742 quieten jira: macro #799

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 1 addition & 5 deletions antora-playbook.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -197,14 +197,10 @@ asciidoc:
cbpp: Couchbase++
kroki-server-url: http://3.91.133.254:9500
kroki-fetch-diagram: true
# the url-issues and url-issues-* attributes configure the URLs for the inline jira macro
url-issues: https://issues.couchbase.com/browse
url-issues-jscbc: https://issues.couchbase.com/browse
url-issues-av: https://couchbasecloud.atlassian.net/browse
url-issues: https://jira.issues.couchbase.com/browse
extensions:
- ./lib/source-url-include-processor.js
- ./lib/json-config-ui-block-macro.js
- ./lib/inline-jira-macro.js
- ./lib/inline-man-macro.js
- ./lib/multirow-table-head-tree-processor.js
- ./lib/swagger-ui-block-macro.js
Expand Down
2 changes: 2 additions & 0 deletions home/modules/contribute/pages/extensions.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

Test and document your Asciidoctor.js or Antora extensions here.

////
== Inline JIRA macro

=== Usage
Expand Down Expand Up @@ -36,6 +37,7 @@ asciidoc:
* jira:JSCBC-1234[]: reversed the polarity of the neutron flow
* jira:AV-2345[]: frobnicated the gostaks
* jira:DOC-999[The dreaded DOC-999 ticket...]: implemented jira macro
////

== Markdown Block

Expand Down
1 change: 0 additions & 1 deletion lib/inline-jira-macro.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,6 @@ function register (registry, context) {
return accum
}, { __DEFAULT__: 'https://issues.couchbase.com/browse' })
Copy link
Contributor

Choose a reason for hiding this comment

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

Bit puzzled by this one. If we're removing this extension from the playbook, then why bother updating the extension so it doesn't output to the log? But on the other hand, if you are updating this extension, shouldn't you at least update the default URL?

Suggested change
}, { __DEFAULT__: 'https://issues.couchbase.com/browse' })
}, { __DEFAULT__: 'https://jira.issues.couchbase.com/browse' })

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Removing the output will mean that anyone with a local playbook that still references the extension will now remove the extra noise once they update docs-site.

(If we simply deleted the extension, then it would break local builds.)

As to why not update the default URL... er... no real reason, I just didn't notice, and as nobody uses it, it doesn't seem that important?

Copy link
Contributor

Choose a reason for hiding this comment

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

Okay, fair enough on the first two points!


console.log(mapping)
const contextWithMapping = Object.assign({ mapping }, context)
registry.inlineMacro('jira', initInlineJiraMacro(contextWithMapping))
}
Expand Down