Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

[docs]: Add federated search to docs #1280

Merged
merged 5 commits into from
Jul 23, 2019

Conversation

belbiy
Copy link
Contributor

@belbiy belbiy commented May 29, 2019

Description

This PR adds the federated search feature to the docs site. You now can search for Devdocs, User Guide and OMS docs from PWA docs.

I would also like to commit Gemfile.lock file as we do on devdocs, since it's better way to manage the updates to theme and other gems this way.

Verification Steps

  1. Go to the docs site
  2. Search for something
  3. Or go to search results page.
  4. See the search results from different sites.

How Have YOU Tested this?

Screenshots / Screen Captures (if appropriate):

Proposed Labels for Change Type/Package

  • major (e.g x.0.0 - a breaking change)
  • minor (e.g 0.x.0 - a backwards compatible addition)
  • patch (e.g 0.0.x - a bug fix)

Checklist:

  • I have updated the documentation accordingly, if necessary.
  • I have added tests to cover my changes, if necessary.

@magento-cicd2
Copy link

magento-cicd2 commented May 29, 2019

CLA assistant check
All committers have signed the CLA.

@vercel
Copy link

vercel bot commented May 29, 2019

This pull request is automatically deployed with Now.
To access deployments, click Details below or on the icon next to each push.

Latest deployment for this branch: https://venia-git-fork-belbiy-ybadd-federated-search.magento-research1.now.sh

@sirugh sirugh added the documentation This pertains to documentation. label May 30, 2019
@sirugh sirugh requested a review from jcalcaben May 30, 2019 13:02
@sirugh sirugh added the version: Patch This changeset includes backwards compatible bug fixes. label May 30, 2019
@jcalcaben jcalcaben added the hold On hold until another condition is fulfilled. label May 30, 2019
@jcalcaben
Copy link
Contributor

This is on hold until @belbiy is ready to make this feature live on all doc sites

@jcalcaben jcalcaben self-assigned this May 30, 2019
@sirugh sirugh changed the title Add federated seach to docs [docs]: Add federated search to docs Jul 10, 2019
@PWAStudioBot
Copy link
Contributor

PWAStudioBot commented Jul 17, 2019

Fails
🚫

The following file(s) were not formatted with prettier. Make sure to execute yarn run prettier locally prior to committing.

dangerfile.js
🚫

No linked issue found. Please link a relevant open issue by adding the text "closes #<issue_number>" in your PR.

🚫

node` failed.

Messages
📖 We are currently working on automating the PR metadata checks. Until that time, you may see failures related to labels/description/linked issues/etc even if you have fixed the problem. Failures will persist until the next push (assuming they are fixed).

Log

ERROR ON TASK: prettierCheck

Error:  Danger had errors running. See message(s) above for more details.
danger-results://tmp/danger-results.json

Generated by 🚫 dangerJS against 5634a76

@belbiy
Copy link
Contributor Author

belbiy commented Jul 23, 2019

@jcalcaben , i'm ready to merge this if you don't mind. What's the next steps to do this?

@PWAStudioBot
Copy link
Contributor

PWAStudioBot commented Jul 23, 2019

Fails
🚫

No linked issue found. Please link a relevant open issue by adding the text "closes #<issue_number>" in your PR.

Messages
📖 We are currently working on automating the PR metadata checks. Until that time, you may see failures related to labels/description/linked issues/etc even if you have fixed the problem. Failures will persist until the next push (assuming they are fixed).

Generated by 🚫 dangerJS against ce0ea5d

Copy link
Contributor

@jcalcaben jcalcaben left a comment

Choose a reason for hiding this comment

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

Looks good to me

@dpatil-magento here are the verification steps I used:

  1. Check out the latest from develop
    git fetch origin && git checkout origin/develop
  2. Pull in the changes for this PR:
    git pull https://github.com/belbiy/pwa-studio.git yb_add-federated-search
  3. Install new ruby dependencies
    bundle install
  4. Install any new node dependencies
    npm install
  5. Run preview server
     npm run develop
  6. Navigate to the home page.
  7. Type in a term in the search box such as "rest"
  8. Verify that multiple results from the different devdoc sites appear
  9. Submit the search term
  10. Verify that you are on the search results page with the search results grouped in different tabs.

@jcalcaben jcalcaben removed the hold On hold until another condition is fulfilled. label Jul 23, 2019
@jcalcaben jcalcaben removed their assignment Jul 23, 2019
@dpatil-magento dpatil-magento self-assigned this Jul 23, 2019
@dpatil-magento dpatil-magento merged commit 45d3b46 into magento:develop Jul 23, 2019
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
documentation This pertains to documentation. version: Patch This changeset includes backwards compatible bug fixes.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants