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.

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

Added examples and updated adoc #46

Merged
merged 10 commits into from
Dec 4, 2023
Merged

Conversation

azainimitre
Copy link
Contributor

No description provided.

@CLAassistant
Copy link

CLAassistant commented Nov 28, 2023

CLA assistant check
All committers have signed the CLA.

@rpiazza
Copy link
Contributor

rpiazza commented Nov 28, 2023

I think the text should be something like this:

==== 2.1.2 Example

[source,json]
----
include::examples/example_2.1.json[]
----

and many of the sections have a x.1.1 - so you should use x.1.2

@rpiazza
Copy link
Contributor

rpiazza commented Nov 29, 2023

You added .1 to the section numbering, but there is already a x.x.1 section called "Relationships". They need to be x.x.2.
Also in section 2.3 - put an example section under each Extension subsection. In other words section 2.3.2.1.1 should be the section for the Availability Impact examples.

@rpiazza
Copy link
Contributor

rpiazza commented Dec 1, 2023

Hi @azainimitre

You can use this command in the extension-definition-specifications directory to generate the html version of the asciidoc. This is the best way to see if the doc looks "good":

asciidoctor -v --failure-level INFO -a stylesheet=../asciidoc-shared/stix.css -D ../../temp incident-core/Incident\ Extension\ Suite.adoc

Then look in ../../temp for Incident Extension Suite.html

A few issues - some of which I should have caught earlier (sorry)

  • Your section headers different - you need to use the same format as the others do
  • The table of contents doesn't include your new section headers, but it might if you use the same format
  • The incident examples (2.2.1) should come after the property table, same for other sections
  • The example for External Impact is the same as the one for Confidentiality Impact
  • The Incident example does not contain the common properties, like "id" and "created", etc
  • Same of Event, Impact and Task.
  • sub objects are not top level objects, so they don't have common properties, e.g., id (see 3.4, 3.5)

@rpiazza
Copy link
Contributor

rpiazza commented Dec 4, 2023

@azainimitre,

some things that still need fixing:

  • move Incident example after the table and relationships
  • many of the Impact examples need common properties

@rpiazza rpiazza merged commit db42a5e into oasis-open:main Dec 4, 2023
2 checks passed
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