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

Add Testing pages #37

Merged
merged 5 commits into from
Apr 13, 2022
Merged

Add Testing pages #37

merged 5 commits into from
Apr 13, 2022

Conversation

sarjona
Copy link
Member

@sarjona sarjona commented Apr 11, 2022

I've started migrating Testing pages, like https://docs.moodle.org/dev/Testing and https://docs.moodle.org/dev/Testing_of_integrated_issues.

While working on this patch, I've also updated the content of these pages:

  • I've removed references to Wednesday (as testing day)
    in the Testing integrated issues, because we're not
    following this approach anymore.
  • I've added a reference and link to Behat on the Testing page.

QUESTION 1: Can a page have no sidebar assigned? I can put the
"Testing integrated issues" into the "Testing" section, but
that's something we might face on other pages. How should we
deal with them?
testingintegratedissues

QUESTION 2: Apart from that, how many category levels we'll support/have?

@sarjona sarjona linked an issue Apr 11, 2022 that may be closed by this pull request
@sarjona sarjona self-assigned this Apr 11, 2022
@andrewnicols
Copy link
Member

andrewnicols commented Apr 12, 2022

QUESTION 1: Can a page have no sidebar assigned? I can put the
"Testing integrated issues" into the "Testing" section, but
that's something we might face on other pages. How should we
deal with them?

For auto-generated sidebars, no. You can't do it but it is apparently on the roadmap.
For manually generated sidebars, yes. You can either not put it in the sidebar configuration, or create a {type: 'ref'} (link).

QUESTION 2: Apart from that, how many category levels we'll support/have?

I would imagine that we don't want it too deep. I'd suggest that three levels is probably the most we want most of the time. That's what I'm looking at for the Acitivty module plugin type.

Screen Shot 2022-04-12 at 13 58 31

@sarjona sarjona force-pushed the testing branch 3 times, most recently from 7431021 to 36010f4 Compare April 12, 2022 14:43
@sarjona sarjona marked this pull request as ready for review April 12, 2022 14:47
@sarjona
Copy link
Member Author

sarjona commented Apr 12, 2022

Andrew, thanks for answering the questions I raised and helping me to find a way to deal with sidebar for pages that are not displayed in sidebar! :-)
As you'll see, I've added a separate commit for it (in order to make it easier to document this change).

For now, this patch migrates the following pages:

I have under my radar other testing pages but, for now, I think it's better to get those and then create a separate patch for the rest :-)

Copy link
Member

@andrewnicols andrewnicols left a comment

Choose a reason for hiding this comment

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

Thanks for working on this Sara,

The changes look awesome :) I've added a few notes, mostly relating to grammar, but a few relating to the use of admonitions and other items.

I feel like we should try to write in full sentences - especially in the admonitions when linking to docs. We should also avoid using them as a stylish wait of adding a header. They should really have content.

Finally I think we should think about our terminology and try to be consistent with it - specifically that we shoudl call the iTeam the "Integration team" in all docs rather than use the colloquialism.

Looks great :) 💃

general/development/process/qatesting.md Outdated Show resolved Hide resolved
general/development/process/qatesting.md Outdated Show resolved Hide resolved
general/development/process/qatesting.md Outdated Show resolved Hide resolved
general/development/process/qatesting.md Outdated Show resolved Hide resolved
general/development/process/qatesting.md Outdated Show resolved Hide resolved
general/development/process/testing.md Outdated Show resolved Hide resolved
general/development/process/testing.md Outdated Show resolved Hide resolved
general/development/process/testing.md Outdated Show resolved Hide resolved
general/development/process/testing.md Outdated Show resolved Hide resolved
sidebars/general.js Outdated Show resolved Hide resolved
sarjona added 4 commits April 13, 2022 09:51
In some pages, we might want to exclude docs from sidebar
generation (but display sidebar when accessing to those
docs).
We've been testing the [ref" item](https://docusaurus.io/docs/next/sidebar/multiple-sidebars#sidebar-item-ref)
but it's for a different purpose.

So, for now, we've added the 'docusausus-hidden' class
to the sidebar in order to display a sidebar for these pages,
without displaying any link in the sidebar.

Example of use:

```
{
    type: 'doc',
    id: 'development/process/testing-integrated-issues',
    className: 'docusaurus-hidden',
},
```
This commit adds the following testing docs:

- Testing
- Testing integrated issues
- QA testing

I've also updated the content of these pages:

- I've removed references to Wednesday (as testing day)
in the Testing integrated issues, because we're not
following this approach anymore.
- I've added reference and link to Behat in Testing page.

The testing sidebar now is generated manually, because
the items should be displayed in the same order as they
appear in the workflow.

Apart from that, some of the testing docs linked from Testing
page, such as Testing integrated issues or QA testing  won't be
displayed in the sidebar (but the sidebar will be displayed
when this doc is accessed).
@sarjona sarjona force-pushed the testing branch 3 times, most recently from 094f054 to f74f6dc Compare April 13, 2022 09:14
@sarjona sarjona requested a review from andrewnicols April 13, 2022 09:20
@sarjona
Copy link
Member Author

sarjona commented Apr 13, 2022

Thanks for the review, Andrew! :-) It looks better now!! <3

As you'll see, I've moved testing-integrated-issues and qatesting to the testing folder (inside process), and also renamed these files (to remove the redundant testing).

Apart from the changes, I've also created the Testing category... In fact, I was wondering if we should split "Process & policies" in two separate items in the navbar (in a different issue): it will remove one level in the sidebar and will help users to find information (because there will different pages for Process and Policies) ;-) What do you think?

@andrewnicols
Copy link
Member

Thanks Sara,

Let's move the discussion of the organisation to a different issue but my concern about that is that things become a little too separate. We can try it though and see how it looks!

@andrewnicols andrewnicols merged commit e427d4f into moodle:main Apr 13, 2022
@sarjona
Copy link
Member Author

sarjona commented Apr 14, 2022

I've created a PoC (and a pull-request) with the proposal for the navbar I mentioned here, to split Process and Policies: #46

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.

[docs] Migrate Testing pages
2 participants