Skip to content

Fix #199, Update obj creation failure requirement#369

Merged
jphickey merged 1 commit intomasterfrom
issue-199-cES1515p1
Oct 23, 2019
Merged

Fix #199, Update obj creation failure requirement#369
jphickey merged 1 commit intomasterfrom
issue-199-cES1515p1

Conversation

@skliper
Copy link
Contributor

@skliper skliper commented Oct 8, 2019

Describe the contribution
Fixes #199, updates obj creation failure requirement to platform defined response

Testing performed
None - document update

Expected behavior changes
None

System(s) tested on:
None

Additional context
Platform defined response now matches cFS PSP model.

Note - Requirements transitioned to new tracking system with minor typo fixes throughout and new output format which changes every line. "Version tracking" is really accomplished in the requirements management tool, not the *.md file.

Contributor Info
Jacob Hageman - NASA/GSFC

@skliper skliper force-pushed the issue-199-cES1515p1 branch from 058caf0 to 85d9340 Compare October 8, 2019 15:50
Copy link
Contributor

@jphickey jphickey left a comment

Choose a reason for hiding this comment

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

It looks like this changed the functional requirements doc from an MD to an HTML file?

Was this intentional?

@skliper
Copy link
Contributor Author

skliper commented Oct 8, 2019

It was the pandoc gfm (github flavored markdown) setting.

@skliper
Copy link
Contributor Author

skliper commented Oct 8, 2019

I tried the standard markdown (--to markdown) and it didn't render the tables in a readable format on GitHub. Happy to supply it in whatever format people want, it's just an output from the tool and pandoc conversions.

@jphickey
Copy link
Contributor

jphickey commented Oct 8, 2019

The version I see now is loaded with HTML tags, it is not markdown at all.

Markdown is definitely preferred as it keeps things easily readable and editable with a standard text editor. Github display on the website is a secondary goal -- most people won't look at it that way. Rather, they will clone the git repo and open their local copy in an editor.

That being said, I believe there is a way to do tables in github-flavored markdown, even if an automatic conversion isn't possible (can always write a one-off perl script to fix it).

Even if not, I would rather see it as a simple (non-tabular) list but keep it as plain text. Right now I can't even see what the actual change was in this pull request, because the entire file is converted to HTML.

@skliper
Copy link
Contributor Author

skliper commented Oct 9, 2019

Uploaded for consideration - *.csv (directly from tool), *.html (from tool with branding removed), .gfm (.html converted with pandoc -gfm), .md (.html converted with pandoc -markdown).

@skliper skliper added the CCB:Approved Indicates code review and approval by community CCB label Oct 10, 2019
@skliper skliper added this to the 6.7.0 milestone Oct 10, 2019
@skliper skliper force-pushed the issue-199-cES1515p1 branch from 939c555 to 6934452 Compare October 10, 2019 20:13
@skliper
Copy link
Contributor Author

skliper commented Oct 10, 2019

Updated per CCB 2019/10/09 review (csv format chosen)

jphickey added a commit that referenced this pull request Oct 11, 2019
Merge branches 'p27', 'p367' and 'p369' for integration
@skliper skliper modified the milestones: 6.7.0, 6.8.0 Oct 15, 2019
@jphickey jphickey merged commit 6934452 into master Oct 23, 2019
@skliper skliper deleted the issue-199-cES1515p1 branch October 31, 2019 17:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CCB:Approved Indicates code review and approval by community CCB

Projects

None yet

Development

Successfully merging this pull request may close these issues.

cFE cES1515.1 Requirement Failure

2 participants