Closed tdcox closed 1 year ago
Name | Link |
---|---|
Latest commit | 0fd8f3d99111fc0fa775d091a7abfe760d60d85c |
Latest deploy log | https://app.netlify.com/sites/cdevents/deploys/63888e88468be40008ccd86a |
Deploy Preview | https://deploy-preview-28--cdevents.netlify.app |
Preview on mobile | Toggle QR Code...Use your smartphone camera to open QR code link. |
To edit notification comments on pull requests, go to your Netlify site settings.
The community pages (contribution guidelines and roadmap) are not easily discoverable
The Community structure is all auto-generated as part of the Docsy defaults. We can override this and develop our own structure if you like? It’s currently exactly the same as Tekton.dev.
It would really be nice to have the various sections of the spec in the navigation on the left as well, but I don't know if that would be possible at all?
I spent three hours last night trying to find a work-around, but it sadly isn’t possible unless we also move those documents to this repo. We can’t use a facade with iframes either, as GitHub detects and prevents it.
On the spec repo we might want to add a landing markdown page with the different icons that looks like the one in https://deploy-preview-28--cdevents.netlify.app/docs/ to make it easier to navigate through spec on github side, and maybe add header/footer links to the various docs in each markdown.
That page uses a lot of HTML templating and an external library so it probably can’t be replicated in Markdown, sadly. We certainly need to remove a bunch of things from that repo, once we merge this PR, and can certainly create some links with matching text content.
It would really be nice to have the various sections of the spec in the navigation on the left as well, but I don't know if that would be possible at all?
I spent three hours last night trying to find a work-around, but it sadly isn’t possible unless we also move those documents to this repo. We can’t use a facade with iframes either, as GitHub detects and prevents it.
Heh, thanks for trying!
The Community structure is all auto-generated as part of the Docsy defaults. We can override this and develop our own structure if you like? It’s currently exactly the same as Tekton.dev.
I'm not suggesting reworking the community page template, but since the community page has no navigation panel, documents in the community folder are not discoverable unless we provide a link to them. So I was suggesting to
In tekton.dev with have:
I'm not suggesting reworking the community page template, but since the community page has no navigation panel, documents in the community folder are not discoverable unless we provide a link to them
I can rework the community page so that it has a side menu. At the moment, it is set up using the docsy defaults, which is a jumping off page that has no sidebar, then a collection of community documents that do have the sidebar.
What I was going to do was to use the jumping off page to post news items, call to actions etc, which are headline information, then nest the reference documentation deeper in the path.
What I was going to do was to use the jumping off page to post news items, call to actions etc, which are headline information, then nest the reference documentation deeper in the path.
See revised version.
We might want to add
.DS_Store
to.gitignore
.
Done.
Thank you for all the updates!! 🤩
I'm not 100% sure about the website versioning part, but that's something we can fine-tune later on. The latest version of the spec is 1.0.2 so that needs to be updated too, but also something we can do in a separate PR.
Will we still have the White Paper and Primer under the spec version
Yes, you still have full version control. Once this is merged, I recommend creating a working branch for any 0.2 changes and use this for version-specific updates until you are ready to release 0.2 formally.
This PR was approved some days ago. Any reason for not merging it?
Signed-off-by: Terry Cox terry@bootstrap.je
Proposed refresh based upon revised location of narrative files