search

neo4j / docs-graphql

GraphQL docs
5 stars 9 forks source link

new structure for directives page #140

Closed rsill-neo4j closed 4 months ago

rsill-neo4j commented 4 months ago

there's no content as of yet for @declareRelationship and @subscriptionsAuthorization. we should add that within this PR - what do you think? @mjfwebb @darrellwarde

darrellwarde commented 4 months ago

there's no content as of yet for @declareRelationship and @subscriptionsAuthorization. we should add that within this PR - what do you think? @mjfwebb @darrellwarde

I think that would be quite a lot of scope creep and would stop these changes being merged for some time. If we're happy with these changes I see no problem with them being merged without these - they will still be table entries as they are now.

rsill-neo4j commented 4 months ago

there's no content as of yet for @declareRelationship and @subscriptionsAuthorization. we should add that within this PR - what do you think? @mjfwebb @darrellwarde

I think that would be quite a lot of scope creep and would stop these changes being merged for some time. If we're happy with these changes I see no problem with them being merged without these - they will still be table entries as they are now.

fair enough. i'll mute the other link (it's currently linking to an empty section) and then we can follow this up when there's capacity for it

darrellwarde commented 4 months ago

I'll just add as a comment - I think these changes have buried "Security" too deeply. If anything I feel like this could be a top-level heading at the same level as "Reference" and "How-to" - they are important features which users look for.

mjfwebb commented 4 months ago

I'll just add as a comment - I think these changes have buried "Security" too deeply. If anything I feel like this could be a top-level heading at the same level as "Reference" and "How-to" - they are important features which users look for.

I tend to agree. I think the Security pages under directives contains more than just the directive references (for example, the page on impersonation and user switching).

Could we keep the reference pages for @authorization and @authentication linked under the directives section, while still having a separate top-level Security section?

I also don't think it's a big problem if that means we link to the directives reference from the Security section.

rsill-neo4j commented 4 months ago

Ok, let's move it up again, and disentangle the content later

neo-technology-commit-status-publisher commented 4 months ago

Thanks for the documentation updates.

The preview documentation has now been torn down - reopening this PR will republish it.